Solution User Actions

https://api.losant.com/orgs/ORG_ID/solutions/SOLUTION_ID/users/SOLUTION_USER_ID

Below are the various requests that can be performed against the Solution User resource, as well as the expected parameters and the potential responses.

Delete

Deletes a solution user

Method And Url

DELETE https://api.losant.com/orgs/ORG_ID/solutions/SOLUTION_ID/users/SOLUTION_USER_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, solutionUser.*, or solutionUser.delete.

Request Path Components

Path Component Description Example
ORG_ID ID associated with the organization 575ed6e87ae143cd83dc4aa8
SOLUTION_ID ID associated with the solution 57955788124b37010084c053
SOLUTIONUSERID ID associated with the solution user 566116085df4b701000258e3

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/orgs/ORG_ID/solutions/SOLUTION_ID/users/SOLUTION_USER_ID

Successful Responses

Code Type Description
200 Success If solution user was successfully deleted

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if solution user was not found

Get

Retrieves information on a solution user

Method And Url

GET https://api.losant.com/orgs/ORG_ID/solutions/SOLUTION_ID/users/SOLUTION_USER_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.read, all.User, all.User.read, solutionUser.*, or solutionUser.get.

Request Path Components

Path Component Description Example
ORG_ID ID associated with the organization 575ed6e87ae143cd83dc4aa8
SOLUTION_ID ID associated with the solution 57955788124b37010084c053
SOLUTIONUSERID ID associated with the solution user 566116085df4b701000258e3

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/orgs/ORG_ID/solutions/SOLUTION_ID/users/SOLUTION_USER_ID

Successful Responses

Code Type Description
200 Solution User Solution user information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if solution user was not found

Patch

Updates information about a solution user

Method And Url

PATCH https://api.losant.com/orgs/ORG_ID/solutions/SOLUTION_ID/users/SOLUTION_USER_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, solutionUser.*, or solutionUser.patch.

Request Path Components

Path Component Description Example
ORG_ID ID associated with the organization 575ed6e87ae143cd83dc4aa8
SOLUTION_ID ID associated with the solution 57955788124b37010084c053
SOLUTIONUSERID ID associated with the solution user 566116085df4b701000258e3

Request Headers

Name Required Description Default
Authorization Y The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Solution User Patch schema. For example, the following would be a valid body for this request:

{
  "password": "aNewUserPassword",
  "forcePasswordResetOnNextLogin": true
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"password":"aNewUserPassword","forcePasswordResetOnNextLogin":true}' \
    https://api.losant.com/orgs/ORG_ID/solutions/SOLUTION_ID/users/SOLUTION_USER_ID

Successful Responses

Code Type Description
200 Solution User Updated solution user information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if solution user was not found