{"info":{"_postman_id":"5c377269-c5c5-470e-b12d-bf9edd52b6e3","name":"BPCC SCIM-Compliant User Provisioning API","description":"<html><head></head><body><h1 id=\"introduction\">Introduction</h1>\n<p>The Bright Pattern Contact Center (BPCC) SCIM-Compliant User Provisioning API implements the System for Cross-domain Identity Management (SCIM) open standard to simplify user provisioning in Bright Pattern cloud contact center environments via a third-party system. SCIM communicates user identity data between identity providers and service providers requiring user identity information.</p>\n<p>With the BPCC SCIM-Compliant User Provisioning API, you can do the following:</p>\n<ul>\n<li>Create new users and define their general (i.e., not contact-center specific) attributes (e.g., names, contact information, photo, etc.)</li>\n<li>Get user information by ID or username</li>\n<li>Update general user properties including username</li>\n<li>Delete existing users</li>\n</ul>\n<p>This document specifies the corresponding REST API methods, with example requests and responses. You can load this API into the <a href=\"https://www.getpostman.com/\">Postman API Development Environment</a> to interact with the API with your own access tokens.</p>\n<p>For the complete SCIM description, see <a href=\"https://tools.ietf.org/html/rfc7643\">RFC 7643</a> and <a href=\"https://tools.ietf.org/html/rfc7644\">RFC 7644</a>.</p>\n<h2 id=\"prerequisites\">Prerequisites</h2>\n<p>To use this API, users will need the following:</p>\n<ul>\n<li>A configured <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/CallCenterConfiguration/IntegrationAccounts/SCIM\">integration account</a></li>\n<li>A user account that will be used for API authentication with the following privileges:<ul>\n<li><a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Privileges#Manage_users\">Manage users</a></li>\n<li><a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Privileges#Manage_all_teams\">Manage all teams</a></li>\n</ul>\n</li>\n</ul>\n<h2 id=\"notes\">Notes</h2>\n<p>In addition to the prerequisites, please note the following.</p>\n<h4 id=\"team-assignment\">Team Assignment</h4>\n<p>Any user created via the SCIM-Compliant User Provisioning API will be assigned to the team specified as the Default team in the <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/CallCenterConfiguration/IntegrationAccounts/SCIM\">integration account</a>.</p>\n<h4 id=\"role-assignment\">Role Assignment</h4>\n<p>User roles can be specified via the API. If no roles are specified, a newly created user will receive the role defined in <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Roles#Assign_this_role_to_newly_created_users\">Assign this role to newly created users</a>.</p>\n<h4 id=\"username-changes\">Username Changes</h4>\n<p>Note that in order for usernames to be changed, service providers must allow this feature for your contact center. For more information, see the <em>Contact Center Administrator Guide</em>, section <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Users\">Users</a>.</p>\n<h4 id=\"passwords\">Passwords</h4>\n<p>Setting a password for a newly created user is optional. Empty passwords can be used, for example, if your contact center users log in via single sign-on (SSO). If the password is not specified, it will be autogenerated. If the password is specified, it must meet all of the password complexity requriements defined by your service provider.</p>\n<h4 id=\"softphones\">Softphones</h4>\n<p>The newly created user accounts receive automatically assigned/created softphone numbers as usual.</p>\n<h4 id=\"microsoft-azure\">Microsoft Azure</h4>\n<p>The BPCC SCIM-Compliant User Provisioning API is compatible with the SCIM schema used by Microsoft Azure.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"}],"owner":"8336025","collectionId":"5c377269-c5c5-470e-b12d-bf9edd52b6e3","publishedId":"SVYwJbLw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-03-02T23:05:39.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Access Token","id":"f19eb234-4dd9-42d1-8f6b-8464aa85f371","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"","description":"<p><a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/Users#Username\">Username</a> of a Bright Pattern user authorized to <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Privileges#Manage_users\">manage users</a> and <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Privileges#Manage_all_teams\">manage all teams</a></p>\n","type":"text"},{"key":"client_secret","value":"","description":"<p><a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Users#API_secret\">API secret key</a> generated for the above user</p>\n","type":"text"},{"key":"scope","value":"","description":"<p>Your contact center URL (e.g., <em>yourcompany.brightpattern.com</em>)</p>\n","type":"text"},{"key":"grant_type","value":"","description":"<p>Grant type; must be set to <em>client_credentials</em></p>\n","type":"text"}]},"url":"https://<tenant_URL>/configapi/v2/oauth/token","description":"<p>Returns an access token that will be used to authenticate each\nsubsequent request made via this API.</p>\n","urlObject":{"protocol":"https","path":["configapi","v2","oauth","token"],"host":["<tenant_URL>"],"query":[],"variable":[]}},"response":[{"id":"e415949c-93d6-43cf-b127-d4071d158db7","name":"Get Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"[Username](https://help.brightpattern.com/5.3:Contact-center-administrator-guide/Users#Username) of a BP user authorized to [manage users](https://help.brightpattern.com/5.3:Contact-center-administrator-guide/Privileges#Manage_users)","key":"client_id","type":"text","value":"some.user"},{"description":"[API secret key](https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Users#API_secret) generated for the above user","key":"client_secret","type":"text","value":"FHjeyOt6LWS7jMvNb6tcjyuU3KDYlG2NjeI6vJBLV72VnLrwexA3imSkkQjSwLuv"},{"description":"Your contact center domain name (e.g., *yourcompany.brightpattern.com*)","key":"scope","type":"text","value":"yourcompany.brightpattern.com"},{"description":"Grant type; must be set to *client_credentials*.","key":"grant_type","type":"text","value":"client_credentials"}]},"url":{"raw":"https:/:tenant-URL/configapi/v2/oauth/token","host":["https"],"port":"","path":[":tenant-URL","configapi","v2","oauth","token"],"variable":[{"key":"tenant-URL","value":"hgsandbox.brightpattern.com"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n    \"access_token\": \"5EIBcIV2zmmlMm1ArGYYnEYFzePHJtXs0dE41LTfMiRH8y607e5cTIEunZS2EvQi\",\n    \"token_type\": \"Bearer\",\n    \"expires_in\": \"3600\",\n    \"scope\": \"hgsandbox.brightpattern.com\"\n}"}],"_postman_id":"f19eb234-4dd9-42d1-8f6b-8464aa85f371"}],"id":"45e86c32-f8be-4c9c-a7d5-10349880bb0e","description":"<p>The <a href=\"https://tools.ietf.org/html/rfc6749#section-4.4\">OAuth 2.0 Client Credentials Grant</a> is used to authenticate clients of this API. The authenticated user is checked for having appropriate privileges to perform the requested operation. The complete list of privileges can be found <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/Privileges\">here</a>. Privileges are assigned to users via one or more <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/Roles\">roles</a>.</p>\n<p>To obtain an access token:</p>\n<ol>\n<li>Login to the Contact Center Administrator application.</li>\n<li>Navigate to the <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/Users\">Users</a> page. Select or create a user with privileges corresponding to the tasks you wish to perform via the BPCC SCIM-Compliant User Provisioning API.</li>\n<li>Click the Generate button to generate an <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Users#API_secret\">API secret key</a>. Copy the generated key and note the username for the next steps.</li>\n<li>Use the <em>Get Access Token</em> method to obtain an access token. Set the <em>client_id</em> to the username and <em>client_secret</em> to the generated API secret key.</li>\n<li>Use the value of <em>access_token</em> returned in the response to set the <em>Authorization: Bearer [access token]</em> header of each subsequent request made via the BPCC SCIM-Compliant User Provisioning API.</li>\n</ol>\n","event":[{"listen":"prerequest","script":{"id":"e213003b-d60c-44dc-bba7-134258c88e7b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ce2c8c67-50c7-4fe1-8330-1c2ce18efcd8","type":"text/javascript","exec":[""]}}],"_postman_id":"45e86c32-f8be-4c9c-a7d5-10349880bb0e"},{"name":"Users","item":[{"name":"Create User","event":[{"listen":"prerequest","script":{"id":"66c9dd52-030e-41d7-803b-453331292ef5","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"268ae4bd-93e4-419c-9902-3efcc2cf430d","exec":["pm.globals.set(\"userId\", pm.response.json().id);"],"type":"text/javascript"}}],"id":"51b1be50-a4ba-44bb-841a-a1f031740d38","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"connection":true}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"schemas\": [\n    \"urn:ietf:params:scim:schemas:core:2.0:User\"\n  ],\n  \"userName\": \"bjensen@example.com\",\n  \"name\": {\n    \"familyName\": \"Jensen\",\n    \"givenName\": \"Barbara\"\n  },\n  \"nickName\": \"Babs\",\n  \"emails\": [\n    {\n      \"value\": \"bjensen@example.com\"\n    }\n  ],\n  \"addresses\": [\n    {\n      \"locality\": \"Hollywood\",\n      \"region\": \"CA\",\n      \"country\": \"US\"\n    }\n  ],\n  \"phoneNumbers\": [\n    {\n      \"value\": \"555-555-5555\",\n      \"type\": \"work\"\n    },\n    {\n      \"value\": \"555-555-4444\",\n      \"type\": \"mobile\"\n    }\n  ],\n  \"photos\": [\n    {\n      \"value\": \"https://www.brightpattern.com/wp-content/uploads/2017/09/bright-pattern-logo-mini-with-text-30.png\",\n      \"type\": \"photo\"\n    }\n  ],\n  \"title\": \"TSR Level 3\",\n  \"timezone\": \"America/Los_Angeles\",\n  \"active\": true\n}"},"url":"https://{{tenant_URL}}/configapi/v2/scim/users","description":"<p>This method creates a new user in your contact center configuration.</p>\n","urlObject":{"protocol":"https","path":["configapi","v2","scim","users"],"host":["{{tenant_URL}}"],"query":[],"variable":[]}},"response":[{"id":"7278fd8d-f845-4f71-a6e8-b49bcd20a3c6","name":"Create user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"schemas\": [\n    \"urn:ietf:params:scim:schemas:core:2.0:User\"\n  ],\n  \"userName\": \"bjensen@example.com\",\n  \"name\": {\n    \"familyName\": \"Jensen\",\n    \"givenName\": \"Barbara\"\n  },\n  \"nickName\": \"Babs\",\n  \"emails\": [\n    {\n      \"value\": \"bjensen@example.com\"\n    }\n  ],\n  \"addresses\": [\n    {\n      \"locality\": \"Hollywood\",\n      \"region\": \"CA\",\n      \"country\": \"US\"\n    }\n  ],\n  \"phoneNumbers\": [\n    {\n      \"value\": \"555-555-5555\",\n      \"type\": \"work\"\n    },\n    {\n      \"value\": \"555-555-4444\",\n      \"type\": \"mobile\"\n    }\n  ],\n  \"photos\": [\n    {\n      \"value\": \"https://secure.gravatar.com/avatar/506c1f645ad2266f2353a50230c52f84.jpg\",\n      \"type\": \"photo\"\n    }\n  ],\n  \"title\": \"TSR Level 3\",\n  \"timezone\": \"America/Los_Angeles\",\n  \"active\": true\n}"},"url":"{{baseUrl}}/configapi/v2/scim/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Location","value":"http://localhost:8080/configapi/v2/scim/users/65625121-E207-4AA6-9C9D-317EE309FFBA","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"696","enabled":true},{"key":"Server","value":"Jetty(9.4.12.v20180830)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:User\"\n    ],\n    \"id\": \"65625121-E207-4AA6-9C9D-317EE309FFBA\",\n    \"externalId\": \"\",\n    \"meta\": {\n        \"resourceType\": \"USER\",\n        \"location\": \"http://localhost:8080/configapi/v2/scim/users/65625121-E207-4AA6-9C9D-317EE309FFBA\"\n    },\n    \"userName\": \"bjensen@example.com\",\n    \"nickName\": \"Babs\",\n    \"name\": {\n        \"familyName\": \"Jensen\",\n        \"givenName\": \"Barbara\"\n    },\n    \"title\": \"TSR Level 3\",\n    \"timezone\": \"America/Los_Angeles\",\n    \"active\": true,\n    \"emails\": [\n        {\n            \"value\": \"bjensen@example.com\",\n            \"primary\": true\n        }\n    ],\n    \"phoneNumbers\": [\n        {\n            \"type\": \"work\",\n            \"value\": \"555-555-5555\"\n        },\n        {\n            \"type\": \"mobile\",\n            \"value\": \"555-555-4444\"\n        },\n        {\n            \"type\": \"extension\",\n            \"value\": \"2083\"\n        }\n    ],\n    \"addresses\": [\n        {\n            \"locality\": \"Hollywood\",\n            \"country\": \"US\"\n        }\n    ],\n    \"roles\": [\n        {\n            \"value\": \"System Administrator\"\n        }\n    ]\n}"}],"_postman_id":"51b1be50-a4ba-44bb-841a-a1f031740d38"},{"name":"Get User by ID","id":"b9d29ffe-adbe-4d08-b8f0-88305b210fab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json OR application/scim+json","type":"text"}],"url":"https://{{tenant_URL}}/configapi/v2/scim/users/:id","description":"<p>This method returns detailed configuration information about an existing user via the user’s ID.</p>\n","urlObject":{"protocol":"https","path":["configapi","v2","scim","users",":id"],"host":["{{tenant_URL}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[{"description":{"content":"<p>The ID of the user whose data is requested (e.g., 5974D6AE-66BD-4B2A-A9D6-1AEADD18F669)</p>\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"56f10629-7a64-4ffa-89c7-9dc0f2c9b7f8","name":"Get User by ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.brightpattern.com/configapi/v2/scim/users/5974D6AE-66BD-4B2A-A9D6-1AEADD18F669"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"696","enabled":true},{"key":"Server","value":"Jetty(9.4.12.v20180830)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n    \"schemas\": [\r\n        \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n    ],\r\n    \"id\": \"5974D6AE-66BD-4B2A-A9D6-1AEADD18F669\",\r\n    \"meta\": {\r\n        \"resourceType\": \"USER\",\r\n        \"created\": \"06-03-2020T10:04:30\",\r\n        \"lastModified\": \"06-03-2020T10:35:28\",\r\n        \"location\": \"http://yourcompany.brightpattern.com/configapi/v2/scim/users/5974D6AE-66BD-4B2A-A9D6-1AEADD18F669\"\r\n    },\r\n    \"userName\": \"elizabeth\",\r\n    \"name\": {\r\n        \"familyName\": \"Smith\",\r\n        \"givenName\": \"Liza\"\r\n    },\r\n    \"active\": true,\r\n    \"emails\": [\r\n        {\r\n            \"value\": \"liza@smith.com\",\r\n            \"primary\": true\r\n        }\r\n    ],\r\n    \"phoneNumbers\": [\r\n        {\r\n            \"type\": \"extension\",\r\n            \"value\": \"2064\"\r\n        }\r\n    ],\r\n    \"addresses\": [\r\n        {}\r\n    ],\r\n    \"roles\": [\r\n        \"System Administrator\",\r\n        \"Campaign Administrator\",\r\n        \"Supervisor\",\r\n        \"Quality Evaluator\",\r\n        \"Quality Evaluator Admin\",\r\n        \"Security Administrator\",\r\n        \"Campaign Operator\",\r\n        \"Service Administrator\",\r\n        \"Reviewer\",\r\n        \"Manager\",\r\n        \"Agent\"\r\n    ]\r\n}"}],"_postman_id":"b9d29ffe-adbe-4d08-b8f0-88305b210fab"},{"name":"Replace User Properties (by replacing all existing attributes with a specified set of replacement attributes)","id":"16ea5d24-fd03-4c3b-a504-6d69e18bbf94","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"connection":true}},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n  \"schemas\": [\r\n    \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n  ],\r\n  \"userName\": \"bjinsin\",\r\n  \"name\": {\r\n    \"familyName\": \"Jinsin\",\r\n    \"givenName\": \"Borbora\"\r\n  },\r\n  \"nickName\": \"Bobs\",\r\n  \"emails\": [\r\n    {\r\n      \"value\": \"bjinsin@example.com\"\r\n    }\r\n  ],\r\n  \"addresses\": [\r\n    {\r\n      \"locality\": \"Hollywood\",\r\n      \"region\": \"CA\",\r\n      \"country\": \"US\"\r\n    }\r\n  ],\r\n  \"phoneNumbers\": [\r\n    {\r\n      \"value\": \"555-555-5555\",\r\n      \"type\": \"work\"\r\n    },\r\n    {\r\n      \"value\": \"888-888-8888\",\r\n      \"type\": \"mobile\"\r\n    }\r\n  ],\r\n  \"title\": \"TSR Level 3\",\r\n  \"timezone\": \"America/Los_Angeles\",\r\n  \"active\": true\r\n}\r\n"},"url":"https://{{tenant_URL}}/configapi/v2/scim/users/:id","description":"<p>Replaces all attributes of an existing user with a specified set of replacement attributes. Note that in accordance with RFC7644, the PUT method updates users by replacing all of their current attributes with the ones specified in the body of the method.</p>\n<p>Note also that in order for usernames to be changed, service providers must allow this feature for your contact center. For more information, see the <em>Contact Center Administrator Guide</em>, section <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Users\">Users</a>.</p>\n","urlObject":{"protocol":"https","path":["configapi","v2","scim","users",":id"],"host":["{{tenant_URL}}"],"query":[],"variable":[{"description":{"content":"<p>The ID of the user whose data is to be updated (e.g., 5974D6AE-66BD-4B2A-A9D6-1AEADD18F669)</p>\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"3b67edd0-44dd-4b61-823a-27f531e8a438","name":"Replace User","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"schemas\": [\r\n    \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n  ],\r\n  \"userName\": \"bjinsin\",\r\n  \"name\": {\r\n    \"familyName\": \"Jinsin\",\r\n    \"givenName\": \"Borbora\"\r\n  },\r\n  \"nickName\": \"Bobs\",\r\n  \"emails\": [\r\n    {\r\n      \"value\": \"bjinsin@example.com\"\r\n    }\r\n  ],\r\n  \"addresses\": [\r\n    {\r\n      \"locality\": \"Hollywood\",\r\n      \"region\": \"CA\",\r\n      \"country\": \"US\"\r\n    }\r\n  ],\r\n  \"phoneNumbers\": [\r\n    {\r\n      \"value\": \"555-555-5555\",\r\n      \"type\": \"work\"\r\n    },\r\n    {\r\n      \"value\": \"888-888-8888\",\r\n      \"type\": \"mobile\"\r\n    }\r\n  ],\r\n  \"title\": \"TSR Level 3\",\r\n  \"timezone\": \"America/Los_Angeles\",\r\n  \"active\": true\r\n}"},"url":"https://yourcompany.brightpattern.com/configapi/v2/scim/users/7D6A5564-2104-442F-82DA-D55B6D7CFAE9"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"660","enabled":true},{"key":"Server","value":"Jetty(9.4.12.v20180830)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n    \"schemas\": [\r\n        \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n    ],\r\n    \"id\": \"7D6A5564-2104-442F-82DA-D55B6D7CFAE9\",\r\n    \"meta\": {\r\n        \"resourceType\": \"USER\",\r\n        \"created\": \"09-03-2020T05:58:01\",\r\n        \"lastModified\": \"09-03-2020T09:21:44\",\r\n        \"location\": \"http://mordor.brightpattern.com/configapi/v2/scim/users/7D6A5564-2104-442F-82DA-D55B6D7CFAE9\"\r\n    },\r\n    \"userName\": \"bjinsin\",\r\n    \"nickName\": \"Bobs\",\r\n    \"name\": {\r\n        \"familyName\": \"Jinsin\",\r\n        \"givenName\": \"Borbora\"\r\n    },\r\n    \"title\": \"TSR Level 3\",\r\n    \"timezone\": \"America/Los_Angeles\",\r\n    \"active\": true,\r\n    \"emails\": [\r\n        {\r\n            \"value\": \"bjinsin@example.com\",\r\n            \"primary\": true\r\n        }\r\n    ],\r\n    \"phoneNumbers\": [\r\n        {\r\n            \"type\": \"work\",\r\n            \"value\": \"555-555-5555\"\r\n        },\r\n        {\r\n            \"type\": \"mobile\",\r\n            \"value\": \"888-888-8888\"\r\n        },\r\n        {\r\n            \"type\": \"extension\",\r\n            \"value\": \"2065\"\r\n        }\r\n    ],\r\n    \"addresses\": [\r\n        {\r\n            \"locality\": \"Hollywood\",\r\n            \"region\": \"CA\",\r\n            \"country\": \"US\"\r\n        }\r\n    ],\r\n    \"roles\": []\r\n}\r\n"}],"_postman_id":"16ea5d24-fd03-4c3b-a504-6d69e18bbf94"},{"name":"Update User (updates only the properties indicated in the specified set)","id":"35640d45-c049-4fbc-8d32-5b303b078f68","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"connection":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n  \"schemas\": [\r\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\r\n  ],\r\n   \"Operations\":[\r\n    {\r\n    \"op\":\"replace\",\r\n    \"path\":\"active\",\r\n    \"value\": false\r\n    }\r\n  ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://{{tenant_URL}}/configapi/v2/scim/users/6BE15F09-BF39-4E20-AB31-A9355CBC01FC","description":"<p>Updates attributes of an existing user. Note that in accordance with RFC7644, the PATCH method modifies a user with a set of client-specified changes (partial update).</p>\n<p>Note also that in order for usernames to be changed, service providers must allow this feature for your contact center. For more information, see the <em>Contact Center Administrator Guide</em>, section <a href=\"https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Users\">Users</a>.</p>\n","urlObject":{"protocol":"https","path":["configapi","v2","scim","users","6BE15F09-BF39-4E20-AB31-A9355CBC01FC"],"host":["{{tenant_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1f228226-a20b-4237-bb40-c46ee67fb69d","name":"Update User (updates only the properties indicated in the specified set)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json OR application/scim+json","disabled":true}],"body":{"mode":"raw","raw":"{\r\n  \"schemas\": [\r\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\r\n  ],\r\n   \"Operations\":[\r\n    {\r\n    \"op\":\"replace\",\r\n    \"path\":\"active\",\r\n    \"value\": false\r\n    }\r\n  ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://{{tenant_URL}}/configapi/v2/scim/users/6BE15F09-BF39-4E20-AB31-A9355CBC01FC"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.10","enabled":true},{"key":"Date","value":"Fri, 01 Apr 2022 01:07:15 GMT","enabled":true},{"key":"Content-Type","value":"application/scim+json","enabled":true},{"key":"Content-Length","value":"707","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:User\"\n    ],\n    \"id\": \"6BE15F09-BF39-4E20-AB31-A9355CBC01FC\",\n    \"meta\": {\n        \"resourceType\": \"USER\",\n        \"lastModified\": \"2022-04-01T01:07:15\",\n        \"location\": \"http://alexei-maintenance.pl.bugfocus.com/configapi/v2/scim/users/6BE15F09-BF39-4E20-AB31-A9355CBC01FC\"\n    },\n    \"userName\": \"carlos.clapper\",\n    \"name\": {\n        \"familyName\": \"Clapper\",\n        \"givenName\": \"Carlos\"\n    },\n    \"timezone\": \"America/Los_Angeles\",\n    \"active\": false,\n    \"emails\": [\n        {\n            \"value\": \"carlos.clapper@servicepattern.sb.office\",\n            \"primary\": true\n        }\n    ],\n    \"phoneNumbers\": [\n        {\n            \"type\": \"extension\",\n            \"value\": \"2025\"\n        }\n    ],\n    \"addresses\": [],\n    \"roles\": [\n        {\n            \"value\": \"System Administrator\"\n        },\n        {\n            \"value\": \"Agent\"\n        }\n    ],\n    \"groups\": [\n        {\n            \"value\": \"84FB1AD4-1B27-4CFA-A1E0-B8A972F3EFA7\",\n            \"display\": \"CSIM Support\"\n        }\n    ]\n}"}],"_postman_id":"35640d45-c049-4fbc-8d32-5b303b078f68"},{"name":"Delete User","id":"c4577d40-c83e-44d5-8752-a0f9b15ef8cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json OR application/scim+json"}],"url":"https://{{tenant_URL}}/configapi/v2/scim/users/:id","description":"<p>Deletes an existing user</p>\n","urlObject":{"protocol":"https","path":["configapi","v2","scim","users",":id"],"host":["{{tenant_URL}}"],"query":[],"variable":[{"description":{"content":"<p>The ID of the user to be deleted (e.g., 7D6A5564-2104-442F-82DA-D55B6D7CFAE9)</p>\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"da1810e0-f17e-4ac3-b2f4-656b56b5ac28","name":"Delete User","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://yourcompany.brightpattern.com/configapi/v2/scim/users/7D6A5564-2104-442F-82DA-D55B6D7CFAE9"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"Jetty(9.4.12.v20180830)","enabled":true}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c4577d40-c83e-44d5-8752-a0f9b15ef8cc"},{"name":"Get User by userName","event":[{"listen":"test","script":{"id":"a7e98e3b-931b-4fb0-b023-6c44f01a04a7","exec":[""],"type":"text/javascript"}}],"id":"0602ff17-2c57-45d2-a2bf-26b09d43604b","protocolProfileBehavior":{"disableBodyPruning":true,"followOriginalHttpMethod":true,"disabledSystemHeaders":{"connection":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://{{tenant_URL}}/configapi/v2/scim/users?filter=userName%20eq%20%22carlos.clapper%22","description":"<p>This method returns detailed configuration information about an existing user via the userName filter.</p>\n","urlObject":{"protocol":"https","path":["configapi","v2","scim","users"],"host":["{{tenant_URL}}"],"query":[{"key":"filter","value":"userName%20eq%20%22carlos.clapper%22"}],"variable":[]}},"response":[{"id":"901cbdce-da11-4c53-a4b6-d3397218d7d8","name":"Get User by userName","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/scim/users?filter=userName eq \"carlos.clapper\"","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","scim","users"],"query":[{"key":"filter","value":"userName eq \"carlos.clapper\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/scim+json","enabled":true},{"key":"Content-Length","value":"861","enabled":true},{"key":"Server","value":"Jetty(9.4.12.v20180830)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n    \"schemas\": [\r\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\r\n    ],\r\n    \"totalResults\": 1,\r\n    \"Resources\": [\r\n        {\r\n            \"schemas\": [\r\n                \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n            ],\r\n            \"id\": \"1F148A86-BF13-4478-A102-F11A8B664FF8\",\r\n            \"meta\": {\r\n                \"resourceType\": \"USER\",\r\n                \"created\": \"06-03-2020T07:46:33\",\r\n                \"location\": \"http://yourcompany.brightpattern.com/configapi/v2/scim/users/1F148A86-BF13-4478-A102-F11A8B664FF8\"\r\n            },\r\n            \"userName\": \"carlos.clapper\",\r\n            \"name\": {\r\n                \"familyName\": \"Clapper\",\r\n                \"givenName\": \"Carlos\"\r\n            },\r\n            \"active\": true,\r\n            \"emails\": [\r\n                {\r\n                    \"value\": \"carlos.clapper@contactcenter.office\",\r\n                    \"primary\": true\r\n                }\r\n            ],\r\n            \"phoneNumbers\": [\r\n                {\r\n                    \"type\": \"extension\",\r\n                    \"value\": \"2025\"\r\n                }\r\n            ],\r\n            \"addresses\": [\r\n                {}\r\n            ],\r\n            \"roles\": [\r\n                \"Agent\"\r\n            ]\r\n        }\r\n    ]\r\n}\r\n"},{"id":"d2f790ac-0d8a-4414-b18d-3dfaf86bf845","name":"Get User by userName","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json OR application/scim+json","type":"text","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{tenant_URL}}/configapi/v2/scim/users?filter=userName%20eq%20%22carlos.clapper%22","protocol":"https","host":["{{tenant_URL}}"],"path":["configapi","v2","scim","users"],"query":[{"key":"filter","value":"userName%20eq%20%22carlos.clapper%22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.10","enabled":true},{"key":"Date","value":"Tue, 15 Mar 2022 23:22:39 GMT","enabled":true},{"key":"Content-Type","value":"application/scim+json","enabled":true},{"key":"Content-Length","value":"806","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n    ],\n    \"totalResults\": 1,\n    \"Resources\": [\n        {\n            \"schemas\": [\n                \"urn:ietf:params:scim:schemas:core:2.0:User\"\n            ],\n            \"id\": \"6BE15F09-BF39-4E20-AB31-A9355CBC01FC\",\n            \"meta\": {\n                \"resourceType\": \"USER\",\n                \"lastModified\": \"2022-03-15T09:41:34\",\n                \"location\": \"http://alexei-maintenance.pl.bugfocus.com/configapi/v2/scim/users/6BE15F09-BF39-4E20-AB31-A9355CBC01FC\"\n            },\n            \"userName\": \"carlos.clapper\",\n            \"name\": {\n                \"familyName\": \"Clapper\",\n                \"givenName\": \"Carlos\"\n            },\n            \"timezone\": \"America/Los_Angeles\",\n            \"active\": true,\n            \"emails\": [\n                {\n                    \"value\": \"carlos.clapper@servicepattern.sb.office\",\n                    \"primary\": true\n                }\n            ],\n            \"phoneNumbers\": [\n                {\n                    \"type\": \"extension\",\n                    \"value\": \"2025\"\n                }\n            ],\n            \"addresses\": [\n                {}\n            ],\n            \"roles\": [\n                {\n                    \"value\": \"System Administrator\"\n                },\n                {\n                    \"value\": \"Agent\"\n                }\n            ],\n            \"groups\": [\n                {\n                    \"value\": \"84FB1AD4-1B27-4CFA-A1E0-B8A972F3EFA7\",\n                    \"display\": \"CSIM Support\"\n                }\n            ]\n        }\n    ]\n}"}],"_postman_id":"0602ff17-2c57-45d2-a2bf-26b09d43604b"}],"id":"59d6c174-2d24-43eb-8e9b-59484ea622a0","description":"<p>With the <em>https://&lt;tenant_url&gt;/configapi/v2/scim/users</em> endpoint, you\ncan do the following:</p>\n<ul>\n<li>Create new users and define most of their attributes</li>\n<li>Get user information by ID or username</li>\n<li>Update user information including username</li>\n<li>Delete existing users</li>\n</ul>\n<p>Below is a description of user attributes that can be accessed via this API. All attributes are strings unless otherwise noted. All attributes are required unless otherwise noted. <strong>Note</strong>: If a certain SCIM field is not listed, it is not supported by BPCC.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>SCIM</strong></th>\n<th><strong>BPCC Mapping</strong></th>\n<th><strong>Required</strong></th>\n<th><strong>Read/Write</strong></th>\n<th><strong>Notes</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>active</td>\n<td>Disabled</td>\n<td>No</td>\n<td>Read/write</td>\n<td>Note the inversion: <em>active = true</em> translates to <em>Disabled = false</em> and vice versa</td>\n</tr>\n<tr>\n<td>addresses/Country</td>\n<td>Country</td>\n<td>No</td>\n<td>Read/write</td>\n<td>See Notes for \"addresses/primary\"</td>\n</tr>\n<tr>\n<td>addresses/locality</td>\n<td>City</td>\n<td>No</td>\n<td>Read/write</td>\n<td>See Notes for \"addresses/primary\"</td>\n</tr>\n<tr>\n<td>addresses/primary</td>\n<td>See Notes</td>\n<td></td>\n<td></td>\n<td>SCIM allows for the specification of multiple physical addresses. If the array contains more than one address, BPCC will take the above attributes from the one that has the  \"primary\" attribute set to \"true\". If none of the addresses have the \"primary\" attribute, BPCC will take the above attributes from the first address in the array.</td>\n</tr>\n<tr>\n<td>addresses/region</td>\n<td>State/Province</td>\n<td>No</td>\n<td>Read/write</td>\n<td>See Notes for \"addresses/primary\"</td>\n</tr>\n<tr>\n<td>emails/primary</td>\n<td>See Notes</td>\n<td></td>\n<td></td>\n<td>SCIM allows for the specification of multiple email addresses. If the array contains more than one email address, BPCC will take the one that has the \"primary\" attribute set to \"true\". If none of the addresses have the \"primary\" attribute, BPCC will take the first email address in the array.</td>\n</tr>\n<tr>\n<td>emails/value</td>\n<td>Email address</td>\n<td>Yes</td>\n<td>Read/write</td>\n<td>See Notes for \"email/primary\"</td>\n</tr>\n<tr>\n<td>externalId</td>\n<td>See \"userName\"</td>\n<td>No</td>\n<td>Read only</td>\n<td>This attribute is ignored in requests; it always sets an empty string in responses.</td>\n</tr>\n<tr>\n<td>id</td>\n<td>UUID of the user object in the Configuration Database</td>\n<td>No</td>\n<td>Read only</td>\n<td>Appears in responses only</td>\n</tr>\n<tr>\n<td>meta/location</td>\n<td>Equal to the \"Location\" header of a newly created resource</td>\n<td>No</td>\n<td>Read only</td>\n<td><a href=\"https://tools.ietf.org/html/rfc7231#section-3.1.4.2\">https://tools.ietf.org/html/rfc7231#section-3.1.4.2</a></td>\n</tr>\n<tr>\n<td>meta/resourceType</td>\n<td>See Notes</td>\n<td>No</td>\n<td>Read only</td>\n<td>Appears in responses only; always set to \"USER\"</td>\n</tr>\n<tr>\n<td>name/familyName</td>\n<td>Last name</td>\n<td>No</td>\n<td>Read/write</td>\n<td>Must be specified in the <strong>Create User</strong> method</td>\n</tr>\n<tr>\n<td>name/givenName</td>\n<td>First name</td>\n<td>No</td>\n<td>Read/write</td>\n<td>Must be specified in the <strong>Create User</strong> method</td>\n</tr>\n<tr>\n<td>nickName</td>\n<td>Chat nickname</td>\n<td>No</td>\n<td>Read/write</td>\n<td></td>\n</tr>\n<tr>\n<td>password</td>\n<td>Password</td>\n<td>No</td>\n<td>Write only</td>\n<td>Setting a password for a newly created user is optional. Empty passwords can be used, for example, if your contact center users log in via single sign-on (SSO). If the password is not specified, it will be autogenerated. If the password is specified, it must meet all of the password complexity requriements defined by your service provider. The password will not be returned in any SCIM responses.</td>\n</tr>\n<tr>\n<td>phoneNumbers/type</td>\n<td>See Notes</td>\n<td></td>\n<td></td>\n<td>-   When set to \"extension\", the \"phoneNumbers/value\" attribute maps to \"Phone extension\"; if the specified number is assigned to another user, the <strong>Create/Update</strong> request will return an error.<br /><br />-   When set to \"default\", the \"phoneNumbers/value\" attribute maps to \"Default hardphone number\".<br /><br />-   When set to \"work\", the \"phoneNumbers/value\" attribute maps to \"Work phone\".<br /><br />-   When set to \"mobile\", the \"phoneNumbers/value\" attribute maps to \"Mobile phone\".<br /><br />-   All other possible types are ignored.</td>\n</tr>\n<tr>\n<td>phoneNumbers/value</td>\n<td>See Notes for “phoneNumbers/type”</td>\n<td>No</td>\n<td>Read/write</td>\n<td></td>\n</tr>\n<tr>\n<td>photos/type</td>\n<td>See Notes for “photo/value”</td>\n<td></td>\n<td></td>\n<td>The following attributes are supported when invoking the “Photo” attribute:<br /><br />-   photo<br />-   thumbnail<br /><br />SCIM allows for the specification of multiple photos. If the array contains more than one photo, BPCC will take the one that has the \"primary\" attribute set to \"true\". In case none of the photos has the \"primary\" attribute set to \"true\", BPCC will take the first photo in the array.</td>\n</tr>\n<tr>\n<td>photos/value</td>\n<td>Photo</td>\n<td>No</td>\n<td>Write only</td>\n<td>In SCIM a photo value is a URI. SCIM does not provide any special guidelines for the photo extraction process. On the BPCC side we will follow these guidelines:<br /><br />-   If the photo array has a value in the Create/Update request, BPCC will immediately attempt to extract the photo from the URI and store it locally. If the attempt fails for any reason, BPCC will respond with an error code (i.e., 400 or 404, depending on whether it is a bad URL or image is not found).<br /><br />-   For dealing with multiple values in the photo array, see Notes for “photo/type”</td>\n</tr>\n<tr>\n<td>roles</td>\n<td>Roles</td>\n<td>No</td>\n<td>Read/write</td>\n<td>An array with the names of roles defined in the BPCC configuration. The specification of a non-existent role will return a 404 error \"Role not found\"</td>\n</tr>\n<tr>\n<td>schemas</td>\n<td>See Notes</td>\n<td>Yes</td>\n<td>N/A</td>\n<td>set to: [\"urn:ietf:params:scim:schemas:core:2.0:User\"]</td>\n</tr>\n<tr>\n<td>timezone</td>\n<td>Time zone</td>\n<td>No</td>\n<td>Read/write</td>\n<td>Both SCIM and BPCC use the IANA (Olson) time zones, so no conversion is required</td>\n</tr>\n<tr>\n<td>title</td>\n<td>Title</td>\n<td>No</td>\n<td>Read/write</td>\n<td></td>\n</tr>\n<tr>\n<td>userName</td>\n<td>Username</td>\n<td>Yes</td>\n<td>Read/write</td>\n<td>Must be specified in the <strong>Create User</strong> method; it can be changed via the <strong>Update User</strong> method</td>\n</tr>\n</tbody>\n</table>\n</div>","event":[{"listen":"prerequest","script":{"id":"53f7d0bc-17a0-4829-9b7a-c33f79c9fe56","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a3583d37-469c-4bcd-9274-44424088e7a4","type":"text/javascript","exec":[""]}}],"_postman_id":"59d6c174-2d24-43eb-8e9b-59484ea622a0"}],"event":[{"listen":"prerequest","script":{"id":"004fa60f-84a4-42a8-b321-6aa59aeebb54","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2929cc6e-fdb9-4f7d-897e-53407cd6553b","type":"text/javascript","exec":[""]}}]}