Create Invitation

POST 
/organizations/:organizationId/invitations

Create invitation for organization

Request

Path Parameters

organizationId stringrequired

The ID of organization.

application/json

Body

required

email stringrequired

The email of user.

familyName stringrequired

The family name of user.

givenName stringrequired

The given name of user.

teamIds string[]required

The team ids of user.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the user who received the invitation.
code stringrequired
familyName stringrequired
givenName stringrequired
email stringrequired
appRole stringrequired
organizationId stringrequired
origin stringrequired
expiredTime numberrequired
createdAtDateString stringrequired
createdAt numberrequired

Example (from schema)

{
  "data": {
    "code": "string",
    "familyName": "string",
    "givenName": "string",
    "email": "string",
    "appRole": "string",
    "organizationId": "string",
    "origin": "string",
    "expiredTime": 0,
    "createdAtDateString": "string",
    "createdAt": 0
  }
}

Example

{
  "data": {
    "code": "l9CgQxxxxxxxxxx=",
    "familyName": "Ashton",
    "givenName": "Kevin",
    "email": "example@infodeck.io",
    "appRole": "RequesterAndViewer",
    "organizationId": "o-organizationId",
    "origin": "owner",
    "expiredTime": 86400,
    "createdAtDateString": "2021-01-01T00:00:00.000Z",
    "createdAt": 1704067200000
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...