Invites

List all invites within an organization

get

Path parameters

organizationIdstringRequired

The id of the organization to find invites within

Query parameters

offsetinteger · int32Optional

The offset into queried items to return

limitinteger · int32 · max: 100Optional

How many items to return at one time (max 100)

Responses

200

A paged array of invites

application/json

default

An error occurred

application/json

get

/v1/identity/organizations/{organizationId}/invites

HTTPcURLJavaScriptPython

GET /v1/identity/organizations/{organizationId}/invites HTTP/1.1
Host: localhost:3050
Accept: */*

{
  "organizationInvites": [
    {
      "id": "text",
      "email": "text",
      "role": "admin",
      "createdAt": "text",
      "createdBy": {
        "userId": "text",
        "type": "user"
      }
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1
}

Create a invite

post

Path parameters

organizationIdstringRequired

The id of the organization to find invites within

Body

application/json

emailstringRequired

rolestring · enumRequiredPossible values:

Responses

200

Expected response to a valid request

application/json

default

An error occurred

application/json

post

/v1/identity/organizations/{organizationId}/invites

HTTPcURLJavaScriptPython

POST /v1/identity/organizations/{organizationId}/invites HTTP/1.1
Host: localhost:3050
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "email": "text",
  "role": "admin"
}

{
  "invite": {
    "id": "text",
    "email": "text",
    "role": "admin",
    "createdAt": "text",
    "createdBy": {
      "userId": "text",
      "type": "user"
    }
  },
  "inviteToken": "text"
}

Delete an invite

delete

Path parameters

organizationIdstringRequired

The id of the organization the invite is within

inviteIdstringRequired

The id of the invite

Responses

204

Expected response to a valid request

No content

default

An error occurred

application/json

delete

/v1/identity/organizations/{organizationId}/invites/{inviteId}

HTTPcURLJavaScriptPython

DELETE /v1/identity/organizations/{organizationId}/invites/{inviteId} HTTP/1.1
Host: localhost:3050
Accept: */*

No content