Instance Organization Invite Actions

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

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

Delete

Revokes an instance org invitation

Method And Url

DELETE https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites/INVITE_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.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.delete.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a95
ORG_ID	ID associated with the organization	575ec8687ae143cd83dc4a97
INVITE_ID	ID associated with the organization invite	575ec8687ae143cd83dc4a94

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/instances/INSTANCE_ID/orgs/ORG_ID/invites/INVITE_ID

Successful Responses

Code	Type	Description
200	Success	If an invite was successfully deleted

Error Responses

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

Get

Returns an organization invite

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites/INVITE_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.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvite.*, or instanceOrgInvite.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a95
ORG_ID	ID associated with the organization	575ec8687ae143cd83dc4a97
INVITE_ID	ID associated with the organization invite	575ec8687ae143cd83dc4a94

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/INVITE_ID

Successful Responses

Code	Type	Description
200	Organization Invitation	A single organization invite

Error Responses

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

Resend Invite

Resend an organization invite with modified role info

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/orgs/ORG_ID/invites/INVITE_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.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.resendInvite.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a95
ORG_ID	ID associated with the organization	575ec8687ae143cd83dc4a97
INVITE_ID	ID associated with the organization invite	575ec8687ae143cd83dc4a94

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

{
  "role": "view"
}

Curl Example

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

Successful Responses

Code	Type	Description
201	Organization Invitation	The new org invite

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance, organization, or invite 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 keys
type:"NotFound"
message:"Application was not found"

Organization Invitation

Schema for a pending invitation to an Organization

Organization Invitation Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 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

Organization Invitation Example

▶
root:{} 9 keys
id:"575ed71e7ae143cd83dc4aaa"
email:"invitedUser@example.com"
role:"edit"
▶
applicationRoles:[] 1 item
▶
dashboardRoles:[] 1 item
inviteDate:"2016-05-13T04:00:00.000Z"
ttl:4233600000
hasExpired:true
disallowTransfer:false

Organization Role Info

Schema for an Organization member's role info

Organization Role Info Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
role:{} 2 keys
▶
applicationRoles:{} 3 keys
▶
dashboardRoles:{} 3 keys
additionalProperties:false

Organization Role Info Example

▶
root:{} 1 key
role:"view"

Success

Schema for reporting a successful operation

Success Schema

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

Success Example

▶
root:{} 1 key
success:true