Named User Service allows you to implement SCIM protocols with uStudio. You can perform create, read, update, and delete (CRUD) operations on users. These actions give you more flexibility in controlling your user base in real time. Please note that groups are not yet available, but actively being developed by uStudio.
We use tokens to authenticate every connection. The service account that will be running the CRUD operations will authenticate with its API token. While each user will authenticate with a short lived token. This token is reissued if and only if the user has valid access. Otherwise, when the user is deactivated, the short lived token will expire and the user will no longer be able to connect to uStudio.
Please contact firstname.lastname@example.org to establish a service account and to receive your SCIM API TOKEN and ACCOUNT-UID.
Standard SCIM User Routes
These routes should allow standard SCIM clients to perform create, read, update, and delete (CRUD) operations on users in uStudio. Operations will require a Named User Service Token as a Bearer TOKEN in the Authorization Header of a request. Example of a user entry:
"givenName": "Firstname", "familyName": "Lastname"
"value": "email@example.com" }],
List all users
Create new user
Get user details
Update user details
For methods that return a list --- GET /Users --- it's possible to filter the list by the userName, email, active, name.givenName, and name.familyName attributes, and return only the values matching that filter. The following rules apply:
- The filter parameter must contain one valid boolean operator.
- Each expression must contain an attribute name followed by an attribute operator, (also supports an optional value).
- Multiple expressions may be combined using two logical operators.
- Expressions can be grouped together using "( )".
- Expressions must be evaluated using standard order of operations.
- String literals must be valid JSON strings.
The following is a list of valid operators:
|ge||greater than or equal|
|le||less than or equal|
Attribute name and attribute operator are case insensitive. For example, the following two expressions will evaluate to the same logical value:
filter=userName Eq "Carly"
filter=username eq "carly"