Manage your users easily
Authentication Token
Authentication token is required to access the Tiled SCIM API. Include the token in the Authorization header as Bearer.
You can generate the token in the Tiled web application under Account Settings in “SCIM Configuration.” Only one token is valid at a time. Replacing an existing token will invalidate the previous one.
Note: The token will only appear once after generation, so copy it and store it securely.
API endpoints
|
Endpoint |
Description |
|---|---|
|
GET /ServiceProviderConfigs |
Returns Tiled’s configuration details |
|
GET /ResourceTypes |
Returns Tiled’s type of resources available |
|
GET /Schemas |
Returns details for how users and groups are formatted |
|
GET /Users |
Returns a paginated list of users |
|
GET /Users/:id |
Retrieves a single user resource |
|
POST /Users |
Creates a user |
|
PUT /Users/:id |
Updates an existing user resource, overwriting all values |
|
PATCH /Users/:id |
Updates an existing user resource, overwriting specified values |
|
DELETE /Users/:id |
Deletes a user |
|
GET /Groups |
Returns a paginated list of groups |
|
GET /Groups/:id |
Retrieves a single group resource |
|
POST /Groups |
Creates a group |
|
PUT /Groups/:id |
Updates an existing group resource, overwriting all values |
|
PATCH /Groups/:id |
Updates an existing group resource, overwriting specified values |
|
DELETE /Groups/:id |
The group itself remains intact, but all members within the group are removed. |
Only the eq operator is supported at this time. Using the eq operator with other operators will result in an invalidFilter error. Additionally, the attribute query will be ignored.
Accepted filter queries for each resource type are:
-
User:
userName -
Group:
displayName
Pagination
All search results will be paginated with a maximum page size of 100. You can optionally include startIndex and count in the body request. If these parameters are absent, they will default to startIndex=1 and count=10.
Patch Operations
Patch operations should have direct targeting (path mode). Operations using filter mode will not be executed. Operations on non-existent resources will be ignored without generating an error. Similarly, operations on attributes not defined in the schemas will also be ignored without generating an error.
User Attributes
|
Field |
SCIM Attribute |
Attribute Type |
Notes |
|---|---|---|---|
|
Name |
|
Singular |
Required. Character length must be >= 3 and < 254 If |
|
|
|
Singular |
Required. |
|
Active |
|
Singular |
|
Custom Attributes
urn:ietf:params:scim:schemas:extension:tiled:2.0:User must be included in the body request.
|
Field |
Custom Attribute |
Attribute Type |
Notes |
|---|---|---|---|
|
Admin |
|
Singular |
|
USER
Provision
Users will be created in Tiled. If the user’s attribute isAdmin is missing or false, the user will be assigned to the account’s default configuration (library and role) or the default library as a base user.
Deprovision
Tiled SCIM API supports DELETE operations, which completely removes the resource from the database.
Users are deprovisioned with the DELETE endpoint, which removes them from the database and anonymizes related analytics data.
Users are deactivated using the PUT endpoint with a request body containing the attribute active=false. This action retains their records in the database, but they will not show on the Tiled app User management page. The deactivated users' analytics will still appear on the Engagement page, marked as “(Deactivated) username”.
Note: Provisioning a user with a duplicate email address will fail, even if the existing user has been deactivated in Tiled. To free up the email for re-provisioning, manually update the existing user's email address in Tiled by either changing the email or deleting the user.
Group Attributes
|
Field |
SCIM Attribute |
Attribute Type |
Notes |
|---|---|---|---|
|
Name |
|
Singular |
Required. |
GROUP
A group maps to a library within Tiled and group members will be assigned to the library.