With the https://<my_tenant_url>/configapi/v2/scim/users endpoint, you
can do the following:
- Create new users and define most of their attributes
- Get user information by ID or username
- Update user information including username
- Delete existing users
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. Note: If a certain SCIM field is not listed, it is not supported by BPCC.
| SCIM | BPCC Mapping | Required | Read/Write | Notes |
|---|---|---|---|---|
| active | Disabled | No | Read/write | Note the inversion: active = true translates to Disabled = false and vice versa |
| addresses/Country | Country | No | Read/write | See Notes for "addresses/primary" |
| addresses/locality | City | No | Read/write | See Notes for "addresses/primary" |
| addresses/primary | See Notes | 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. | ||
| addresses/region | State/Province | No | Read/write | See Notes for "addresses/primary" |
| emails/primary | See Notes | 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. | ||
| emails/value | Email address | Yes | Read/write | See Notes for "email/primary" |
| externalId | See "userName" | No | Read only | This attribute is ignored in requests; it always sets an empty string in responses. |
| id | UUID of the user object in the Configuration Database | No | Read only | Appears in responses only |
| meta/location | Equal to the "Location" header of a newly created resource | No | Read only | https://tools.ietf.org/html/rfc7231#section-3.1.4.2 |
| meta/resourceType | See Notes | No | Read only | Appears in responses only; always set to "USER" |
| name/familyName | Last name | No | Read/write | Must be specified in the Create User method |
| name/givenName | First name | No | Read/write | Must be specified in the Create User method |
| nickName | Chat nickname | No | Read/write | |
| password | Password | No | Write only | 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. |
| phoneNumbers/type | See Notes | - When set to "extension", the "phoneNumbers/value" attribute maps to "Phone extension"; if the specified number is assigned to another user, the Create/Update request will return an error. - When set to "default", the "phoneNumbers/value" attribute maps to "Default hardphone number". - When set to "work", the "phoneNumbers/value" attribute maps to "Work phone". - When set to "mobile", the "phoneNumbers/value" attribute maps to "Mobile phone". - All other possible types are ignored. | ||
| phoneNumbers/value | See Notes for “phoneNumbers/type” | No | Read/write | |
| photos/type | See Notes for “photo/value” | The following attributes are supported when invoking the “Photo” attribute: - photo - thumbnail 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. | ||
| photos/value | Photo | No | Write only | 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: - 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). - For dealing with multiple values in the photo array, see Notes for “photo/type” |
| roles | Roles | No | Read/write | 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" |
| schemas | See Notes | Yes | N/A | set to: ["urn:ietf:params:scim:schemas:core:2.0:User"] |
| timezone | Time zone | No | Read/write | Both SCIM and BPCC use the IANA (Olson) time zones, so no conversion is required |
| title | Title | No | Read/write | |
| userName | Username | Yes | Read/write | Must be specified in the Create User method; it can be changed via the Update User method |