Invite users in an organization

post

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

rolestring · enum · nullableOptional

Default role to set on newly invited members.

Possible values:

ssobooleanOptional

If true, invites the user as an SSO user of the organization. Defaults to false.

Responses

200

OK

application/json

usersstring[]Required

The unique identifiers of the users who were added to the organization

invitednumberRequired

The number of users who were added to the organization

failedSSOEmailsstring[]Optional

A list of emails who were invited to the organization, but who were not added as SSO users as they are members of another org

400

Bad Request

application/json

post/orgs/{organizationId}/invites

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/invites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "emails": [
    "[e-mail]"
  ],
  "role": "admin",
  "sso": true
}

{
  "users": [
    "text"
  ],
  "invited": 1,
  "failedSSOEmails": [
    "text"
  ]
}