Organizations

POST organization accept invitation

Accept an invitation to an organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

invitationId*string

The ID of the invitation to accept

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/accept-invitation" \  -H "Content-Type: application/json" \  -d '{    "invitationId": "string"  }'

{  "invitation": {},  "member": {}}

POST organization cancel invitation

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

invitationId*string

The ID of the invitation to cancel

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/cancel-invitation" \  -H "Content-Type: application/json" \  -d '{    "invitationId": "string"  }'

{  "message": "string"}

POST organization check slug

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

slug*string

The organization slug to check. Eg: "my-org"

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/check-slug" \  -H "Content-Type: application/json" \  -d '{    "slug": "string"  }'

{  "message": "string"}

POST organization create

Create an organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

The name of the organization

Length1 <= length

slug*string

The slug of the organization

Length1 <= length

userId?string

The user id of the organization creator. If not provided, the current user will be used. Should only be used by admins or when called by the server. server-only. Eg: "user-id"

logo?|

The logo of the organization

metadata?

The metadata of the organization

keepCurrentActiveOrganization?boolean

Whether to keep the current active organization active after creating a new one. Eg: true

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "slug": "string"  }'

{  "id": "string",  "name": "string",  "slug": "string",  "logo": "string",  "createdAt": "2019-08-24T14:15:22Z",  "metadata": "string"}

POST organization delete

Delete an organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

organizationId*string

The organization id to delete

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/delete" \  -H "Content-Type: application/json" \  -d '{    "organizationId": "string"  }'

"string"

GET organization get active member

Get the member details of the active organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/organization/get-active-member"

{  "id": "string",  "userId": "string",  "organizationId": "string",  "role": "string"}

GET organization get active member role

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/organization/get-active-member-role"

{  "message": "string"}

GET organization get full organization

Get the full organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/organization/get-full-organization"

{  "id": "string",  "name": "string",  "slug": "string",  "logo": "string",  "createdAt": "2019-08-24T14:15:22Z",  "metadata": "string"}

GET organization get invitation

Get an invitation by ID

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Query Parameters

id?string

The ID of the invitation to get

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/organization/get-invitation"

{  "id": "string",  "email": "string",  "role": "string",  "organizationId": "string",  "inviterId": "string",  "status": "string",  "expiresAt": "string",  "organizationName": "string",  "organizationSlug": "string",  "inviterEmail": "string"}

GET organization get organization

Get the organization metadata

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/organization/get-organization"

{  "id": "string",  "name": "string",  "slug": "string",  "logo": "string",  "createdAt": "2019-08-24T14:15:22Z",  "metadata": "string"}

POST organization has permission

Check if the user has permission

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

permission?

Deprecated

The permission to check

permissions*

The permission to check

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/has-permission" \  -H "Content-Type: application/json" \  -d '{    "permissions": {}  }'

{  "error": "string",  "success": true}

POST organization invite member

Create an invitation to an organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

The email address of the user to invite

role*|array<>

The role(s) to assign to the user. It can be admin, member, owner. Eg: "member"

organizationId?string

The organization ID to invite the user to

resend?boolean

Resend the invitation email, if the user is already invited. Eg: true

teamId?|array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/invite-member" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "role": "string"  }'

{  "id": "string",  "email": "string",  "role": "string",  "organizationId": "string",  "inviterId": "string",  "status": "string",  "expiresAt": "string",  "createdAt": "string"}

POST organization leave

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

organizationId*string

The organization Id for the member to leave. Eg: "organization-id"

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/leave" \  -H "Content-Type: application/json" \  -d '{    "organizationId": "string"  }'

{  "message": "string"}

GET organization list

List all organizations

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/organization/list"

[  {    "id": "string",    "name": "string",    "slug": "string",    "logo": "string",    "createdAt": "2019-08-24T14:15:22Z",    "metadata": "string"  }]

GET organization list invitations

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/organization/list-invitations"

{  "message": "string"}

GET organization list members

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/organization/list-members"

{  "message": "string"}

GET organization list user invitations

List all invitations a user has received

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/auth/organization/list-user-invitations"

[  {    "id": "string",    "email": "string",    "role": "string",    "organizationId": "string",    "organizationName": "string",    "inviterId": "string",    "teamId": "string",    "status": "string",    "expiresAt": "string",    "createdAt": "string"  }]

POST organization reject invitation

Reject an invitation to an organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

invitationId*string

The ID of the invitation to reject

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/reject-invitation" \  -H "Content-Type: application/json" \  -d '{    "invitationId": "string"  }'

{  "invitation": {},  "member": {}}

POST organization remove member

Remove a member from an organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

memberIdOrEmail*string

The ID or email of the member to remove

organizationId?string

The ID of the organization to remove the member from. If not provided, the active organization will be used. Eg: "org-id"

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/remove-member" \  -H "Content-Type: application/json" \  -d '{    "memberIdOrEmail": "string"  }'

{  "member": {    "id": "string",    "userId": "string",    "organizationId": "string",    "role": "string"  }}

POST organization set active

Set the active organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

organizationId?|

The organization id to set as active. It can be null to unset the active organization. Eg: "org-id"

organizationSlug?string

The organization slug to set as active. It can be null to unset the active organization if organizationId is not provided. Eg: "org-slug"

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/set-active" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "slug": "string",  "logo": "string",  "createdAt": "2019-08-24T14:15:22Z",  "metadata": "string"}

POST organization update

Update an organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

data*

organizationId?string

The organization ID. Eg: "org-id"

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/update" \  -H "Content-Type: application/json" \  -d '{    "data": {}  }'

{  "id": "string",  "name": "string",  "slug": "string",  "logo": "string",  "createdAt": "2019-08-24T14:15:22Z",  "metadata": "string"}

POST organization update member role

Update the role of a member in an organization

Authorization

bearerAuth

AuthorizationBearer <token>

Session token from the set-auth-token response header (bearer plugin)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*|array<string>

The new role to be applied. This can be a string or array of strings representing the roles. Eg: ["admin", "sale"]

memberId*string

The member id to apply the role update to. Eg: "member-id"

organizationId?string

An optional organization ID which the member is a part of to apply the role update. If not provided, you must provide session headers to get the active organization. Eg: "organization-id"

Response Body

`application/json`

curl -X POST "https://example.com/api/auth/organization/update-member-role" \  -H "Content-Type: application/json" \  -d '{    "role": "string",    "memberId": "string"  }'

{  "member": {    "id": "string",    "userId": "string",    "organizationId": "string",    "role": "string"  }}

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`