API
SCIM Server API¶
SCIM 2.0 clients can also connect directly with the Privacera SCIM Server via the REST API.
Obtain the SCIM Server URL:
- PrivaceraCloud - URL that was generated for you, and the Username/Password or Bearer Token you provided in your PrivaceraCloud account in Configure SCIM Server in PrivaceraCloud.
- Self Managed - https://{SCIM_SERVER_HOST}}/api/pus/public/scim/v2/{connectorName} .
Use Basic Authentication (base64 encoded username and password) to authenticate each API request.
See SCIM 2.0 Specification for specific protocol and call schemas.
Supported SCIM REST API Requests¶
SCIM Server supports the following requests:
GET - /Users
- Params
- startIndex
- count
- filter (Supports single filter for ‘eq’ operator on the following attributes: userName, givenName, firstName, active)
GET - /Users/{userId}
POST - /Users
- Params
- user (SCIM User JSON)
PUT - /Users/{userId}
- Params
- user (SCIM User JSON)
GET - /Groups
- Params
- startIndex
- count
- filter (Supports single filter for ‘eq’ operator on the following attributes: displayName)
GET - /Groups/{groupId}
POST - /Groups
- Params
- group (SCIM Group JSON)
PATCH - /Groups/{groupId}
- Params
- operations (SCIM Operation list) Supported Operations:
op: replace
path:members
value:[{value: userId} … ]
op: remove
path: members[value eq “userId”]
op: add
path: members
value: [{value:userId} … ]
- Prev topic: SCIM Server Integration
- Next topic: Advanced Configuration