Skip to main content

Users Endpoints

This feature includes endpoints related to activities you can perform for user management (account members) within the StackSpot EDP Platform.

MethodEndpointDescriptionParametersResponses
GET/scim/UsersGet All UserX-Tenant-Id: string (header)200: OK
POST/scim/UsersCreate a new UserX-Tenant-Id: string (header), body: Create User201: Created
PUT/scim/Users/{id}Update UsersX-Tenant-Id: string (header), body: Update User200: OK
DELETE/scim/Users/{id}Delete UserX-Tenant-Id: string (header)204: No Content
PATCH/scim/Users/{id}Patch Operation UserX-Tenant-Id: string (header), body: Update User200: OK

Response Definitions

domain.CreateUser

FieldTypeRequired
activebooleanNo
displayNamestringNo
emailsarray of object (primary, type, value)No
localestringNo
nameobject (familyName, givenName)No
nickNamestringNo
passwordstringNo
phoneNumbersarray of object (primary, type, value)No
preferredLanguagestringNo
profileUrlstringNo
timezonestringNo
titlestringNo
urn:ietf:params:scim:schemas:extension:custom:2.0:Userobject (blocked, company, ddd, ddi, gender, generatePassword, hireDate, human, is_email_verified, machineName, preferredLoginName, properties, resourceOwner)No
userNamestringNo
userTypestringNo

domain.UpdateUser

FieldTypeRequired
emailsarrayNo
nameobjectNo
phoneNumbersarrayNo
urn:ietf:params:scim:schemas:extension:custom:2.0:UserobjectNo
userNamestringNo

domain.UserAttributes

FieldTypeRequired
activebooleanNo
displayNamestringNo
emailsarrayNo
localestringNo
nameobjectNo
nickNamestringNo
passwordstringNo
phoneNumbersarrayNo
preferredLanguagestringNo
profileUrlstringNo
timezonestringNo
titlestringNo
urn:ietf:params:scim:schemas:extension:custom:2.0:UserobjectNo
userNamestringNo
userTypestringNo

domain.UserDomain

FieldTypeRequired
attributesobjectYes
externalIDobjectNo
idstringYes
metaobjectYes
schemasarrayYes

domain.UserPageDomain

FieldTypeRequired
resourcesarrayYes
totalResultsintegerYes

domain.UserPatchOperation

FieldTypeRequired
OperationsarrayYes
schemasstringYes

Example Response

GET /tenant-id/scim/Users Get all Users

Here you find an example of the API response for the endpoint GET /tenant-id/scim/Users Get all Users.

Request:

GET /tenant-id/scim/Users Get all Users

Header:
Authorization: Bearer token

Response:

Status-Code 200: {
"Resources": [
{
"attributes": null,
"block_and_date": "",
"block_start_date": "",
"block_type_name": "",
"company": "",
"displayName": "User Example",
"emails": [
{
"display": "Work Email",
"type": "work",
"value": "Example@stackspot.com"
},
{
"display": "Personal Email",
"type": "Personal",
"value": "example.user@stackspot.com"
}
],
"gender": "",
"groups": null,
"hire_date": "",
"human": true,
"id": "5126b021-050a-4320-9aa8-59c964e2797d",
"is_blocked": false,
"is_email_verified": false,
"is_phone_verified": false,
"machine_name": "",
"meta": {
"resourceType": "User",
"created": "2024-03-01T17:57:14Z",
"lastModified": "2024-05-16T14:26:39Z",
"location": "Users/5126b021-050a-4320-9aa8-59c964e2797d",
"version": "1"
},
"name": {
"familyName": "Example",
"formatted": "Example User",
"givenName": "User"
},
"never_logged": true,
"phoneNumbers": [
{
"value": "5511 912345678"
}
],
"preferredLanguage": "und",
"preferredLoginName": "",
"profileUrl": "",
"properties": null,
"required_actions": [
"otp-configure"
],
"resource_owner": "",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:custom:2.0:User"
],
"userName": "lucas.torres@dev.stackspot.com"
}
],
"itemsPerPage": 100,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"startIndex": 1,
"totalResults": 1
}

POST /tenant-id/scim/Users Create Users

Here you find an example of the API response for the endpoint POST /tenant-id/scim/Users Create Users.

Request:

POST /tenant-id/scim/Users Create Users

Header:
Authorization: Bearer token

Response:

Status-Code 201: {
"attributes": null,
"block_and_date": "",
"block_start_date": "",
"block_type_name": "",
"company": "Default",
"displayName": "FirstNameLastName",
"emails": [
{
"display": "Work Email",
"type": "work",
"value": "work@example.com"
},
{
"display": "Personal Email",
"type": "Personal",
"value": "personal@example.com"
}
],
"gender": "M",
"groups": null,
"hire_date": "08/04/1198",
"human": true,
"id": "056b9f27-a813-4b3b-ba16-ebf164a63203",
"is_blocked": false,
"is_email_verified": false,
"is_phone_verified": false,
"machine_name": "MyMachineName",
"meta": {
"resourceType": "User",
"created": "2024-05-31T17:05:25Z",
"lastModified": "2024-05-31T17:05:25Z",
"location": "Users/056b9f27-a813-4b3b-ba16-ebf164a63203",
"version": "1"
},
"name": {
"familyName": "LastName",
"formatted": "FirstNameLastName",
"givenName": "FirstName"
},
"never_logged": true,
"phoneNumbers": [
{
"value": "5541999999999"
}
],
"preferredLanguage": "und",
"preferredLoginName": "MyPreferredLogin",
"profileUrl": "",
"properties": null,
"required_actions": [
"otp-configure"
],
"resource_owner": "",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:custom:2.0:User"
],
"userName": "test.scim@dev.stackspot.com"
}

GET /tenant-id/scim/Users/\{id} Get User By Id

Here you find an example of the API response for the endpoint GET /tenant-id/scim/Users/\{id} Get User By Id.

Request:

GET /tenant-id/scim/Users/\{id} Get User By Id

Header:
Authorization: Bearer token

Response:

Status-Code 200: {
"attributes": null,
"block_and_date": "",
"block_start_date": "",
"block_type_name": "",
"company": "Default",
"displayName": "FirstNameLastName",
"emails": [
{
"display": "Work Email",
"type": "work",
"value": "work@example.com"
},
{
"display": "Personal Email",
"type": "Personal",
"value": "personal@example.com"
}
],
"gender": "M",
"groups": null,
"hire_date": "08/04/1198",
"human": true,
"id": "056b9f27-a813-4b3b-ba16-ebf164a63203",
"is_blocked": false,
"is_email_verified": false,
"is_phone_verified": false,
"machine_name": "MyMachineName",
"meta": {
"resourceType": "User",
"created": "2024-05-31T17:05:25Z",
"lastModified": "2024-05-31T17:05:25Z",
"location": "Users/056b9f27-a813-4b3b-ba16-ebf164a63203",
"version": "1"
},
"name": {
"familyName": "LastName",
"formatted": "FirstNameLastName",
"givenName": "FirstName"
},
"never_logged": true,
"phoneNumbers": [
{
"value": "554199999999"
}
],
"preferredLanguage": "und",
"preferredLoginName": "MyPreferredLogin",
"profileUrl": "",
"properties": null,
"required_actions": [
"otp-configure"
],
"resource_owner": "",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:custom:2.0:User"
],
"userName": "test.scim@dev.stackspot.com"
}

PUT /tenant-id/scim/Users/\{id} Update User

Here you find an example of the API response for the endpoint PUT /tenant-id/scim/Users/\{id} Update User.

Request:

PUT /tenant-id/scim/Users/\{id} Update User

Header:
Authorization: Bearer token

Response:

Status-Code 200: {
"attributes": null,
"block_and_date": "",
"block_start_date": "",
"block_type_name": "",
"company": "Default",
"displayName": "FirstNameLastName",
"emails": [
{
"display": "Work Email",
"type": "work",
"value": "work@example.com"
},
{
"display": "Personal Email",
"type": "Personal",
"value": "personal@example.com"
}
],
"gender": "M",
"groups": null,
"hire_date": "08/04/1198",
"human": true,
"id": "056b9f27-a813-4b3b-ba16-ebf164a63203",
"is_blocked": false,
"is_email_verified": false,
"is_phone_verified": false,
"machine_name": "MyMachineName",
"meta": {
"resourceType": "User",
"created": "2024-05-31T17:05:25Z",
"lastModified": "2024-05-31T17:05:25Z",
"location": "Users/056b9f27-a813-4b3b-ba16-ebf164a63203",
"version": "1"
},
"name": {
"familyName": "LastName",
"formatted": "FirstNameLastName",
"givenName": "FirstName"
},
"never_logged": true,
"phoneNumbers": [
{
"value": "554199999999"
}
],
"preferredLanguage": "und",
"preferredLoginName": "MyPreferredLogin",
"profileUrl": "",
"properties": null,
"required_actions": [
"otp-configure"
],
"resource_owner": "",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:custom:2.0:User"
],
"userName": "test.scim@dev.stackspot.com"
}

DELETE /tenant-id/scim/Users/\{id} Remove User

Here you find an example of the API response for the endpoint DELETE /tenant-id/scim/Users/\{id} Remove User.

Request:

DELETE /tenant-id/scim/Users/\{id} Remove User

Header:
Authorization: Bearer token

Response:

Status-Code 204: NO BODY RESPONSE

PATCH /tenant-id/scim/Users/\{id} Update UsersWith Patch operation

Here you find an example of the API response for the endpoint PATCH /tenant-id/scim/Users/\{id} Update UsersWith Patch operation.

Request:

PATCH /tenant-id/scim/Users/\{id} Update UsersWith Patch operation

Header:
Authorization: Bearer token

Response:

Status-Code 200: {
"attributes": null,
"block_and_date": "",
"block_start_date": "",
"block_type_name": "",
"company": "Default",
"displayName": "FirstNameLastName",
"emails": [
{
"display": "Work Email",
"type": "work",
"value": "work@example.com"
},
{
"display": "Personal Email",
"type": "Personal",
"value": "personal@example.com"
}
],
"gender": "M",
"groups": null,
"hire_date": "08/04/1198",
"human": true,
"id": "056b9f27-a813-4b3b-ba16-ebf164a63203",
"is_blocked": false,
"is_email_verified": false,
"is_phone_verified": false,
"machine_name": "MyMachineName",
"meta": {
"resourceType": "User",
"created": "2024-05-31T17:05:25Z",
"lastModified": "2024-05-31T17:05:25Z",
"location": "Users/056b9f27-a813-4b3b-ba16-ebf164a63203",
"version": "1"
},
"name": {
"familyName": "LastName",
"formatted": "FirstNameLastName",
"givenName": "FirstName"
},
"never_logged": true,
"phoneNumbers": [
{
"value": "554199999999"
}
],
"preferredLanguage": "und",
"preferredLoginName": "MyPreferredLogin",
"profileUrl": "",
"properties": null,
"required_actions": [
"otp-configure"
],
"resource_owner": "",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:custom:2.0:User"
],
"userName": "test.scim@dev.stackspot.com"
}