Lucid offers user provisioning/de-provisioning and group management via CRUD operations against the users and groups on an enterprise account via our SCIM REST API. For a more detailed overview of SCIM, see Simple Cloud. To access the REST API, follow the steps below.
All Lucid SCIM endpoints start with the Lucid base URL, which can be obtained on the same page as the SCIM bearer token (Admin > App Integration > SCIM):
Lucid: https://users.lucid.app/scim/v2
Authorization is provided by using the HTTP Authorization header, formed as such (using your own bearer token instead of the example token shown):
Authorization: Bearer 1502c55ad68b4f3acdc969a7179a1313
{
"id": string,
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User",
"urn:lucidchart:schemas:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:2.0:User"
],
"userName": string,
"name": {
"formatted": string, // givenName + " " + familyName
"givenName": string,
"familyName": string
},
"displayName": string,
"emails": [{
"value": string, // email address
"primary": boolean
}],
"groups": [{
"display": string,
"value": string, //group identifer
}],
"active": boolean,
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User": {
"billingCode": string,
"productLicenses": {
"Lucidchart": boolean,
"Lucidspark": boolean,
"LucidscaleCreator": boolean,
"LucidscaleExplorer": boolean
}
},
"meta": Meta,
"roles": [String]
}
Property | Description |
---|---|
|
String Will be in the form "lucid-1234" with 1234 being the ID of the Lucid user |
|
Array[String] ["urn:ietf:params:scim:schemas:core:2.0:User"] |
|
String Usually the email address of the user |
|
Object |
|
String Usually the email address of the user |
|
Array[Object] |
|
Boolean User's administrative status, or whether a user can log in |
|
Object Includes user's license status in "productLicenses" |
|
Meta |
|
Array[String] A list of administrative roles assigned to the user |
Assigning a role to a user allows that user to perform administrative actions associated with that role. Learn more about Administrator Roles.
|
Billing admins manage invoices and billing details and can increase the license count. |
|
Document admins can use document discovery to search and view all documents owned by their team’s account. |
|
Team admins can make account-wide changes such as to account settings, user management, licenses, and integrations. |
|
Template admins manage your corporate templates. |
{
"resourceType": "User",
"created": string,
"lastModified": string,
"version": string,
"location": string
}
Property | Description |
---|---|
resourceType | String "User" or "Group" |
created | String ISO8601 DateTime |
lastModified | String ISO8601 DateTime |
version | String |
location | String URI of user or group |
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": string,
"name": {
"formatted": string,
"familyName": string,
"givenName": string
},
"displayName": string,
"password": string,
"emails": [{
"value": string, // email address
"type": string (optional),
"primary": boolean (optional)
}],
"active": boolean,
"id": string,
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User": {
"billingCode": string (optional),
"productLicenses": {
"Lucidchart": boolean,
"Lucidspark": boolean,
"LucidscaleCreator": boolean,
"LucidscaleExplorer": boolean
}
},
"urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User": {
"addOns": [string] (optional) // valid addOns: “chart-for-sales”
},
"roles": [string]
}
Property | Description |
---|---|
|
Array[String] ["urn:ietf:params:scim:schemas:core:2.0:User"] |
|
String |
|
Array[Object] |
|
Object Products omitted from the “productLicenses” attribute will use the accounts auto-grant settings to determine the user’s license. |
|
Object |
|
Usually the email address of the user |
|
Passwords must be at least 6 characters in length (Lucid password requirement) |
|
|
|
|
|
Contains the user’s add-on licenses: |
|
Lucid roles (“Team Admin”, “Billing Admin”, etc) that are listed will be added to the user for all products. |
{
"op": string,
"path" : string (optional),
"value": JSON (optional)
}
Property | Description |
---|---|
op | String Can be "add", "remove" or "replace" |
path |
|
value |
Object or array to be added/replaced |
curl 'https://users.lucid.app/scim/v2/Users/lucid-1234' \
--request 'GET' \
--header 'Authorization: Bearer <Token>'
HTTP/1.1 200 Ok
Content-Type: application/json
{
"urn:lucidchart:schemas:1.0:User": {
"canEdit": true,
"addOns": []
},
"displayName": "example@example.com",
"roles": [],
"canEdit": true,
"active": true,
"groups": [
{
"display": "Group 1",
"value": "lucid-group-100002331"
}
],
"userName": "example@example.com",
"emails": [
{
"value": "example@example.com",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User": {
"canEdit": true,
"addOns": []
},
"meta": {
"resourceType": "User",
"created": "2021-03-02T00:08:17Z",
"lastModified": "2022-01-12T21:51:33Z",
"version": "W/\"1642024293000\"",
"location": "https://users.lucid.app/scim/v2/chart/Users/lucid-1234"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:lucidchart:schemas:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:2.0:User"
],
"name": {
"formatted": "Jane Doe",
"givenName": "Jane",
"familyName": "Doe"
},
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User": {
"billingCode": null,
"productLicenses": {
"Lucidchart": true,
"Lucidspark": true,
"LucidscaleCreator": false,
"LucidscaleExplorer": false
},
"officeIdAtPrintVendor": null,
"userIdAtPrintVendor": null
},
"urn:ietf:params:scim:schemas:extension:lucid:2.0:User": {
"billingCode": null,
"productLicenses": {
"Lucidchart": true,
"Lucidspark": true,
"LucidscaleCreator": false,
"LucidscaleExplorer": false
},
"officeIdAtPrintVendor": null,
"userIdAtPrintVendor": null
},
"id": "lucid-1234"
}
Get a specific user on the account.
|
ID of the Lucid user to get. Example |
|
with User Resource |
|
if bearer token is invalid |
|
if the user was not found |
curl 'https://users.lucid.app/scim/v2/Users' \
--request 'GET' \
--header 'Authorization: Bearer <Token>'
HTTP/1.1 200 Ok
Content-Type: application/json
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 153,
"startIndex": 1,
"itemsPerPage": 100,
"Resources": [UserResource]
}
Gets all users on an account.
|
Index of the first user in the list to return (1 indexed). Example |
|
Quantity of users to return from this request. Example |
|
See SCIM spec and optimization details below:
Example Example |
|
with JSON object containing list of users. Deactivated users will not be included in the totalResults or the JSON payload of users returned. |
|
if bearer token is invalid |
curl 'https://users.lucid.app/scim/v2/Users' \
--request 'POST' \
--header 'Authorization: Bearer <Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:lucidchart:schemas:1.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"userName": "example@example.com",
"name": {
"formatted": "Jane Doe",
"givenName": "Jane",
"familyName": "Doe"
},
"displayName": "Jane Doe",
"emails": [
{
"primary": true,
"value": "example@example.com"
}
],
"active": true
"urn:lucidchart:schemas:1.0:User" : {
"canEdit": false
},
"urn:ietf:params:scim:schemas:extension:lucid:2.0:User": {
"productLicenses": {
"Lucidchart": true,
"Lucidspark": false,
"LucidscaleCreator": false,
"LucidscaleExplorer": false
}
},
}'
Create a new user.
|
|
with User Resource |
|
if bearer token is invalid |
|
if username or email already exists on the account |
|
if add-on license requires base license to be active |
curl 'https://users.lucid.app/scim/v2/Users/lucid-1234' \
--request 'PUT' \
--header 'Authorization: Bearer <Token>' \
--data-raw '{
"roles": [
"Team Admin",
"Billing Admin"
],
"name": {
"formatted": "Jane Doe",
"givenName": "Jane",
"familyName": "Doe"
},
"userName": "example@example.com",
"emails": [
{
"value": "example@example.com",
"primary": true
}
],
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:lucidchart:schemas:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:2.0:User"
],
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User": {
"billingCode": null,
"productLicenses": {
"Lucidchart": true,
"Lucidspark": false,
"LucidscaleCreator": false,
"LucidscaleExplorer": false
},
"officeIdAtPrintVendor": null,
"userIdAtPrintVendor": null
}
}'
HTTP/1.1 200 Ok
Content-Type: application/json
{
"urn:lucidchart:schemas:1.0:User": {
"canEdit": true,
"addOns": []
},
"displayName": "example@example.com",
"roles": [
"Team Admin",
"Billing Admin"
],
"canEdit": true,
"active": true,
"groups": [
{
"display": "Group 1",
"value": "lucid-group-100002331"
},
{
"display": "Group 2",
"value": "lucid-group-100002653"
}
],
"userName": "example@example.com",
"emails": [
{
"value": "example@example.com",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User": {
"canEdit": true,
"addOns": []
},
"meta": {
"resourceType": "User",
"created": "2021-06-09T15:43:53Z",
"lastModified": "2022-01-15T00:09:49Z",
"version": "W/\"1642205389000\"",
"location": "https://users.lucid.app/scim/v2/chart/Users/lucid-1433"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:lucidchart:schemas:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:2.0:User"
],
"name": {
"formatted": "Group 2",
"givenName": "Group 2",
"familyName": ""
},
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User": {
"billingCode": null,
"productLicenses": {
"Lucidchart": true,
"Lucidspark": false,
"LucidscaleCreator": false,
"LucidscaleExplorer": false
},
"officeIdAtPrintVendor": null,
"userIdAtPrintVendor": null
},
"urn:ietf:params:scim:schemas:extension:lucid:2.0:User": {
"billingCode": null,
"userIdAtPrintVendor": null,
"officeIdAtPrintVendor": null,
"productLicenses": {
"LucidscaleCreator": false,
"Lucidchart": true,
"LucidscaleExplorer": false,
"Lucidspark": false
}
},
"id": "lucid-1234"
}
Modify an existing user.
|
ID of the Lucid user to modify. Example |
|
|
with User Resource |
|
if request body syntax is incorrect |
|
if bearer token is invalid |
|
if the user does not exist |
|
if new username or email already exists on account |
curl 'https://users.lucid.app/scim/v2/Users/lucid-1234' \
--request 'PATCH' \
--header 'Authorization: Bearer <Token>' \
--header 'Content-Type: application/json' \
--data-raw ' {
"schemas": ["urn:ietf:params:scim:api:message:2.0:PatchOp"],
"Operations": [{
"op": "replace",
"value": {
"active": true
}
}]
}'
HTTP/1.1 200 Ok
Content-Type: application/json
{
"urn:lucidchart:schemas:1.0:User": {
"canEdit": true,
"addOns": []
},
"displayName": "example@example.com",
"roles": [],
"canEdit": true,
"active": true,
"groups": [
{
"display": "Group 1",
"value": "lucid-group-100002331"
}
],
"userName": "example@example.com",
"emails": [
{
"value": "example@example.com",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User": {
"canEdit": true,
"addOns": []
},
"meta": {
"resourceType": "User",
"created": "2021-03-02T00:08:17Z",
"lastModified": "2022-01-12T21:51:33Z",
"version": "W/\"1642024293000\"",
"location": "https://users.lucid.app/scim/v2/chart/Users/lucid-1234"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:lucidchart:schemas:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User",
"urn:ietf:params:scim:schemas:extension:lucid:2.0:User"
],
"name": {
"formatted": "Jane Doe",
"givenName": "Jane",
"familyName": "Doe"
},
"urn:ietf:params:scim:schemas:extension:lucid:1.0:User": {
"billingCode": null,
"productLicenses": {
"Lucidchart": true,
"Lucidspark": true,
"LucidscaleCreator": false,
"LucidscaleExplorer": false
},
"officeIdAtPrintVendor": null,
"userIdAtPrintVendor": null
},
"urn:ietf:params:scim:schemas:extension:lucid:2.0:User": {
"billingCode": null,
"productLicenses": {
"Lucidchart": true,
"Lucidspark": true,
"LucidscaleCreator": false,
"LucidscaleExplorer": false
},
"officeIdAtPrintVendor": null,
"userIdAtPrintVendor": null
},
"id": "lucid-1234"
}
Modify an existing user.
|
ID of the Lucid user to modify. Example |
|
[ "urn:ietf:params:scim:schemas:core:2.0:PatchOp" ] |
|
|
|
with User Resource |
|
if request body syntax is incorrect |
|
if bearer token is invalid |
|
if the user was not found |
|
if new username or email already exists on account |
{
"id": string,
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"displayName": string,
"members": [Member],
"meta": Meta
}
Property | Description |
---|---|
|
String Will be in the form "lucid-group-1234" with 1234 being the ID of the Lucid group |
|
Array[String] ["urn:ietf:params:scim:schemas:core:2.0:Group"] |
|
String |
|
Array[Member] |
|
Meta |
{
"value": string,
"$ref": string,
"display": string
}
Parameters that are marked optional are ignored when using the Groups API
Property | Description |
---|---|
value | String ID of group member |
$ref |
URI of group member |
display |
|
{
"resourceType": "Group",
"created": string,
"lastModified": string,
"version": string,
"location": string
}
Property | Description |
---|---|
resourceType | String "Group" |
created | String ISO8601 DateTime |
lastModified | String ISO8601 DateTime |
version | String |
location | String URI of group |
{
"op": string,
"path": string (optional),
"value": JSON (optional)
}
Property | Description |
---|---|
op | String Can be "add", "remove" or "replace" |
path |
Path to the field you want to change |
value |
Object or array to be added/replaced |
curl 'https://users.lucid.app/scim/v2/Groups/lucid-group-1234' \
--request 'GET' \
--header 'Authorization: Bearer <Token>'
HTTP/1.1 200 Ok
Content-Type: application/json
{
"id": "lucid-group-1234",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"displayName": "Group 1",
"members": [
{
"value": "lucid-1433",
"$ref": "https://users.lucid.app/scim/v2/chart/Users/lucid-1433",
"display": "User 1"
},
{
"value": "lucid-1754",
"$ref": "https://users.lucid.app/scim/v2/chart/Users/lucid-1754",
"display": "User 2"
},
{
"value": "lucid-group-100003005",
"$ref": "https://users.lucid.app/scim/v2/chart/Groups/lucid-group-100003005",
"display": "Group 2"
},
{
"value": "lucid-group-100003067",
"$ref": "https://users.lucid.app/scim/v2/chart/Groups/lucid-group-100003067",
"display": "Group 3"
}
],
"meta": {
"resourceType": "Group",
"created": "2021-06-09T15:42:57Z",
"lastModified": "2021-07-01T19:44:08Z",
"version": "W/\"1625168648000\"",
"location": "https://users.lucid.app/scim/v2/chart/Groups/lucid-group-1234"
}
}
Get a specific group on the account.
|
ID of the Lucid group to get. Example |
|
with Group |
|
if bearer token is invalid |
|
if the group was not found |
curl 'https://users.lucid.app/scim/v2/Groups' \
--request 'GET' \
--header 'Authorization: Bearer <Token>'
HTTP/1.1 200 Ok
Content-Type: application/json
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 25,
"startIndex": 1,
"itemsPerPage": 100,
"Resources": [Groups]
}
Gets all groups on an account.
|
with JSON object containing list of groups. |
|
if bearer token is invalid |
curl 'https://users.lucid.app/scim/v2/Groups' \
--request 'POST' \
--header 'Authorization: Bearer <Token>'
--header 'Content-Type: application/json' \
--data-raw '{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"displayName": "Group A",
"members": [
{
"value": "lucid-1234"
},
{
"value": "lucid-5678"
}
]
}'
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "lucid-group-100003105",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"displayName": "Group 3",
"members": [],
"meta": {
"resourceType": "Group",
"created": "2022-01-14T21:56:07Z",
"lastModified": "2022-01-14T21:56:07Z",
"version": "W/\"1642197367000\"",
"location": "https://users.lucid.app/scim/v2/chart/Groups/lucid-group-100003105"
}
}
Create a new group.
|
["urn:ietf:params:scim:schemas:core:2.0:Group"] |
|
|
|
|
|
with Group |
|
if group was not created |
|
if bearer token is invalid |
curl 'https://users.lucid.app/scim/v2/Groups/lucid-group-1234' \
--request 'PUT' \
--header 'Authorization: Bearer <Token>'
--header 'Content-Type: application/json' \
--data-raw '{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"displayName": "Group A",
"members": [
{
"value": "lucid-1234"
},
{
"value": "lucid-5678"
}
]
}'
Modify an existing group.
|
["urn:ietf:params:scim:schemas:core:2.0:Group"] |
|
|
|
|
|
with Group |
|
if bearer token is invalid |
|
if the group was not found |
|
if group name already exists on the account |
curl 'https://users.lucid.app/scim/v2/Groups/lucid-group-1234' \
--request 'PATCH' \
--header 'Authorization: Bearer <Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:PatchOp"
],
"Operations": [
{
"op": "add",
"path": "members",
"value": [
{"value": "lucid-1499"},
{"value": "lucid-1500"}
]
}
]
}'
Modify an existing group.
|
ID of the Lucid group to modify. Example |
|
[ "urn:ietf:params:scim:schemas:core:2.0:PatchOp" ] |
|
Type of permission being given. Valid values are "account", "document" or "user". |
|
with Group |
|
if request body syntax is incorrect |
|
if bearer token is invalid |
|
if the group was not found |
|
if group name already exists on the account |
curl 'https://users.lucid.app/scim/v2/Groups/lucid-group-1234' \
--request 'DELETE' \
--header 'Authorization: Bearer <Token>'
HTTP/1.1 204 No Content
Content-Length: 0
Delete an existing group.
|
ID of the Lucid group to modify. Example |
|
if delete was successful |
|
if group has license allotments or primary users |
|
if bearer token is invalid |
|
if the group was not found |
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
"id": string,
"name": string,
"description": string,
"attributes": [Attribute],
"meta": Meta,
}
Property | Description |
---|---|
|
Array[String] ["urn:ietf:params:scim:schemas:core:2.0:Schema"] |
|
String |
|
String |
|
String |
|
Array[Attribute] |
|
Meta |
{
"name": string,
"type": string,
"multiValued": boolean,
"description": string,
"required": boolean,
"caseExact": boolean,
"mutability": string,
"returned": string,
"uniqueness": string,
}
Property | Description |
---|---|
|
String |
|
String Value can be parsed as: "boolean", "decimal", "integer", "dateTime", "reference", or "complex" based on its content |
|
Boolean |
|
String |
|
Boolean |
|
Boolean |
|
String Can be "readOnly", "readWrite" (default), "immutable", or "writeOnly" |
|
String Can be "always", "never", "default" (default), or "request" |
|
String Can be "none" (default), "server", or "global" |
{
"resourceType": "Schema",
"location": string
}
Property | Description |
---|---|
resourceType | String "Schema" |
location | String URI of schema |
curl 'https://users.lucid.app/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group' \
--request 'GET' \
--header 'Authorization: Bearer <Token>'
HTTP/1.1 200 Ok
Content-Type: application/json
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"id": "urn:ietf:params:scim:schemas:core:2.0:Group",
"name": "Group",
"description": "",
"attributes": [
{
"name": "id",
"type": "string",
"multiValued": false,
"description": "",
"required": true,
"caseExact": false,
"mutability": "readOnly",
"returned": "always",
"uniqueness": "global"
},
{
"name": "displayName",
"type": "string",
"multiValued": false,
"description": "",
"required": true,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "members",
"type": "complex",
"multiValued": true,
"description": "",
"required": true,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
}
],
"meta": {
"resourceType": "Schema",
"location": "/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
}
}
Get a specific Lucid resource schema.
|
ID of the Lucid resource schema to get. Example |
|
with Schema |
|
if bearer token is invalid |
|
if the schema was not found |
curl 'https://users.lucid.app/scim/v2/Schemas' \
--request 'GET' \
--header 'Authorization: Bearer <Token>'
HTTP/1.1 200 Ok
Content-Type: application/json
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"itemsPerPage": 50,
"startIndex": 1,
"totalResults": 2,
"Resources": [Schemas]
}
Gets all Lucid resource schemas.
|
with JSON object containing list of schemas. |
|
if bearer token is invalid |
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],
"documentationUri": string,
"patch": {
"supported": boolean
},
"filter": {
"supported": boolean,
"maxResults": integer
},
"changePassword": {
"supported": boolean
},
"sort": {
"supported": boolean
},
"etag": {
"supported": boolean
},
"authenticationSchemas": [AuthenticationSchema],
"meta": Meta
}
Property | Description |
---|---|
|
Array[String] ["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"] |
|
String Link to Lucid documentation |
|
Object Describes configuration of the PATCH endpoint |
|
Object Describes configuration of the "filter" option on GET endpoints |
|
Object Describes whether SCIM can be used to change a password |
|
Object Describes configuration of the "sort" option on GET endpoints |
|
Object Describes etag configuration |
|
Array[AuthenticationSchema] Specifies properties of the SCIM authentication scheme |
|
Meta |
{
"name": string,
"description": string,
"specUri": string,
"documentationUri": string,
"type": string,
"primary": boolean
}
Property | Description |
---|---|
name | String |
description | String |
specUri | String |
documentationUri | String |
type | String |
primary | Boolean |
{
"resourceType": "ServiceProviderConfig",
"location": "/v2/Schemas/ServiceProviderConfig",
"version": integer
}
Property | Description |
---|---|
resourceType | String "ServiceProviderConfig" |
location | String "/v2/Schemas/ServiceProviderConfig" |
version | Integer |
curl 'https://users.lucid.app/scim/v2/ServiceProviderConfig' \
--request 'GET' \
--header 'Authorization: Bearer <Token>'
HTTP/1.1 200 Ok
Content-Type: application/json
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
],
"documentationUri": "https://lucidco.zendesk.com/hc/articles/360049427352-SCIM-Overview",
"patch": {
"supported": true
},
"filter": {
"supported": true,
"maxResults": "100"
},
"changePassword": {
"supported": true
},
"sort": {
"supported": false
},
"etag": {
"supported": true
},
"authenticationSchemas": [
{
"name": "OAuth Bearer Token",
"description": "Authentication scheme using the OAuth Bearer Token Standard",
"specUri": "http://www.rfc-editor.org/info/rfc6750",
"documentationUri": "https://lucidco.zendesk.com/hc/articles/360049427352-SCIM-Overview#bearer-token-authorization",
"type": "oauthbearertoken",
"primary": true
}
],
"meta": {
"resourceType": "ServiceProviderConfig",
"location": "/v2/Schemas/ServiceProviderConfig",
"version": 1
}
}
Get the service provider configuration.
|
with ServiceProviderConfig |
|
if bearer token is invalid |