Instance Organization Members Actions

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

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

Get

Returns a collection of instance organization members

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_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.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceOrgMembers.*, or instanceOrgMembers.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97
ORG_ID	ID associated with the organization	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/orgs/ORG_ID/members

Successful Responses

Code	Type	Description
200	Instance Organization Members	A collection of instance organization members

Error Responses

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

Post

Creates a new organization member

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_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, instanceOrgMembers.*, or instanceOrgMembers.post.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97
ORG_ID	ID associated with the organization	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 Org Member Post schema. For example, the following would be a valid body for this request:

{
  "role": "view",
  "applicationRoles": [
    {
      "resourceId": "575ef90f7ae143cd83dc4a4f",
      "role": "none"
    }
  ],
  "userId": "675ed18f7ae143cd83dc4bb7"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"role":"view","applicationRoles":[{"resourceId":"575ef90f7ae143cd83dc4a4f","role":"none"}],"userId":"675ed18f7ae143cd83dc4bb7"}' \
    https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/members

Successful Responses

Code	Type	Description
201	Instance Org Member	The newly added instance org member
202	Instance Organization Invite Sent	An invite was sent to the new member's email address

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:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

Instance Organization Invite Sent

Schema returned when adding a new instance organization member resulted in an invite being sent

Instance Organization Invite Sent Schema

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

Instance Organization Invite Sent Example

▶
(root){} 1 key
inviteSent:true

Instance Org Member

Schema for an Instance Organization member

Instance Org Member Schema

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

Instance Org Member Example

▶
(root){} 2 keys
userId:"575ef90f7ae143cd83dc4aad"
role:"view"

Instance Org Member Post

Schema for an Instance Organization member creation request

Instance Org Member Post Schema

▶
(root){} 2 keys
$schema:"http://json-schema.org/draft-07/schema#"
▶
oneOf:[] 2 items

Instance Org Member Post Example

▶
(root){} 3 keys
role:"view"
▶
applicationRoles:[] 1 item
userId:"675ed18f7ae143cd83dc4bb7"

Instance Organization Members

Schema for a collection of Organization members within an instance

Instance Organization Members Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys
▶
items:{} 2 keys
▶
instanceId:{} 2 keys
▶
orgId:{} 2 keys
▶
count:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys

Instance Organization Members Example

▶
(root){} 4 keys
▶
items:[] 1 item
count:8
sortField:"role"
sortDirection:"asc"