Instance Members Actions

https://api.losant.com/instances/INSTANCE_ID/members

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

Get

Returns a collection of instance members

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/members

Authentication

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

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: email, role	email	`sortField=role`
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	`sortDirection=asc`
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role		`filterField=email`
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		`filter=my * instance`

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/instances/INSTANCE_ID/members

Successful Responses

Code	Type	Description
200	Instance Members	A collection of instance members

Error Responses

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

Post

Creates a new instance member

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/members

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.User, instanceMembers.*, or instanceMembers.post.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

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 Instance Member Post schema. For example, the following would be a valid body for this request:

{
  "userId": "675ed18f7ae143cd83dc4bb7",
  "role": "view"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"userId":"675ed18f7ae143cd83dc4bb7","role":"view"}' \
    https://api.losant.com/instances/INSTANCE_ID/members

Successful Responses

Code	Type	Description
200	Instance Member	The newly created instance member

Error Responses

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

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keystype:"NotFound"
message:"Application was not found"

Instance Member

Schema for an Instance member

Instance Member Schema

▶
root:{} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys▶
instanceId:{} 2 keys
▶
userId:{} 2 keys
▶
email:{} 3 keys
▶
firstName:{} 3 keys
▶
lastName:{} 2 keys
▶
role:{} 2 keys
▶
avatarUrl:{} 3 keys
▶
twoFactorAuthEnabled:{} 1 key
▶
ssoLinked:{} 1 key
additionalProperties:false

Instance Member Example

▶
root:{} 2 keysuserId:"575ef90f7ae143cd83dc4aad"
role:"view"

Instance Member Post

Schema for an Instance member creation request

Instance Member Post Schema

▶
root:{} 5 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
userId:{} 2 keys
▶
email:{} 3 keys
▶
role:{} 2 keys
additionalProperties:false
▶
anyOf:[] 2 items

Instance Member Post Example

▶
root:{} 2 keysuserId:"675ed18f7ae143cd83dc4bb7"
role:"view"