Instance Organization Invites Actions

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

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

Get

Returns a collection of instance organization invites

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites

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, instanceOrgInvites.*, or instanceOrgInvites.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, inviteDate	inviteDate	sortField=role
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	desc	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/invites

Successful Responses

Code	Type	Description
200	Instance Organization Invitations	A collection of instance organization invitations

Error Responses

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

Post

Invites a member to an instance organization

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites

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, instanceOrgInvites.*, or instanceOrgInvites.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 Organization Invitation Post schema. For example, the following would be a valid body for this request:

{
  "email": "invitedUser@example.com",
  "role": "edit"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"email":"invitedUser@example.com","role":"edit"}' \
    https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites

Successful Responses

Code	Type	Description
201	Instance Organization Invitation	The new organization invite

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance or organization 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 Invitation

Schema for a pending invitation to an Organization within an instance

Instance Organization Invitation Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 12 keys
▶
id:{} 2 keys
▶
email:{} 3 keys
▶
role:{} 2 keys
▶
applicationRoles:{} 3 keys
▶
dashboardRoles:{} 3 keys
▶
inviteDate:{} 2 keys
▶
ttl:{} 1 key
▶
hasExpired:{} 1 key
▶
disallowTransfer:{} 1 key
▶
inviteId:{} 2 keys
▶
instanceId:{} 2 keys
▶
orgId:{} 2 keys

Instance Organization Invitation Example

▶
(root){} 12 keys
id:"575ec8687ae143cd83dc4a97"
email:"test@example.com"
role:"admin"
applicationRoles:[] 0 items
dashboardRoles:[] 0 items
inviteDate:"2016-06-13T04:00:00.000Z"
ttl:604800000
hasExpired:false
disallowTransfer:false
inviteId:"575ec8687ae143cd83dc4a97"
instanceId:"575ec8687ae143cd83dc4a98"
orgId:"575ec8687ae143cd83dc4a99"

Instance Organization Invitations

Schema for a collection of pending invitations to an Instance Organization

Instance Organization Invitations Schema

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

Instance Organization Invitations Example

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

Organization Invitation Post

Schema for the body of a request to send an invitation

Organization Invitation Post Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
email:{} 3 keys
▶
role:{} 2 keys
▶
applicationRoles:{} 3 keys
▶
dashboardRoles:{} 3 keys
▶
disallowTransfer:{} 1 key
additionalProperties:false
▶
required:[] 2 items

Organization Invitation Post Example

▶
(root){} 2 keys
email:"invitedUser@example.com"
role:"edit"