Memberships

List organization memberships

Retrieve a list of all organizations the user is a member of

GET/me/memberships

Authorization

user

Query parameters

Response

200422

OK

Body

application/json

nextPageTokenstring

The token to fetch the next page of results. If empty, there are no more results to fetch.

results*array of OrganizationMembership

Request

JavaScriptCurlPython

const response = await fetch('/me/memberships', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200422

{
  "nextPageToken": "text",
  "results": [
    {
      "organization": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "slug": "text",
        "avatarUrl": "text",
        "status": "active",
        "statusReason": "text",
        "owner": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2024-11-21T08:53:42.926Z",
        "updatedAt": "2024-11-21T08:53:42.926Z",
        "managedBy": [
          {
            "Type": "text",
            "ID": "text"
          }
        ]
      },
      "status": "banned",
      "createdAt": "2024-11-21T08:53:42.926Z",
      "updatedAt": "2024-11-21T08:53:42.926Z",
      "roleRefs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "requiredSsoAuth": false,
      "requiredMfaAuth": false
    }
  ]
}

Get organization membership

Retrieve a single organization membership object.

GET/me/memberships/{organizationId}

Authorization

user

Path parameters

organizationId*string

The organization ID

Response

200404

OK

Body

application/json

organization*Organization

The organization record

status*MembershipStatus (enum)

The status of user's membership on the organization.

bannedinvitedactive

createdAt*string (date-time)

When the membership was created.

updatedAt*string (date-time)

When the membership was last updated.

roleRefs*array of RoleReference

THe list of roles to assign to the membership

requiredSsoAuthboolean

Indicates if SSO Authentication is required for this membership

requiredMfaAuthboolean

Indicates if MFA Authentication is required for this membership

Request

JavaScriptCurlPython

const response = await fetch('/me/memberships/{organizationId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "slug": "text",
    "avatarUrl": "text",
    "status": "active",
    "statusReason": "text",
    "owner": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-11-21T08:53:42.926Z",
    "updatedAt": "2024-11-21T08:53:42.926Z",
    "managedBy": [
      {
        "Type": "text",
        "ID": "text"
      }
    ]
  },
  "status": "banned",
  "createdAt": "2024-11-21T08:53:42.926Z",
  "updatedAt": "2024-11-21T08:53:42.926Z",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "requiredSsoAuth": false,
  "requiredMfaAuth": false
}

Accept organization invitation

Accept a pending invitation to join the organization.

POST/me/memberships/{organizationId}

Authorization

user

Path parameters

organizationId*string

The organization ID

Response

200404409

OK

Body

application/json

organization*Organization

The organization record

status*MembershipStatus (enum)

The status of user's membership on the organization.

bannedinvitedactive

createdAt*string (date-time)

When the membership was created.

updatedAt*string (date-time)

When the membership was last updated.

roleRefs*array of RoleReference

THe list of roles to assign to the membership

requiredSsoAuthboolean

Indicates if SSO Authentication is required for this membership

requiredMfaAuthboolean

Indicates if MFA Authentication is required for this membership

Request

JavaScriptCurlPython

const response = await fetch('/me/memberships/{organizationId}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404409

{
  "organization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "slug": "text",
    "avatarUrl": "text",
    "status": "active",
    "statusReason": "text",
    "owner": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-11-21T08:53:42.926Z",
    "updatedAt": "2024-11-21T08:53:42.926Z",
    "managedBy": [
      {
        "Type": "text",
        "ID": "text"
      }
    ]
  },
  "status": "banned",
  "createdAt": "2024-11-21T08:53:42.926Z",
  "updatedAt": "2024-11-21T08:53:42.926Z",
  "roleRefs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "requiredSsoAuth": false,
  "requiredMfaAuth": false
}

Leave organization

Remove the membership from the organization for the current user

DELETE/me/memberships/{organizationId}

Authorization

user

Path parameters

organizationId*string

The organization ID

Response

204404

OK

Request

JavaScriptCurlPython

const response = await fetch('/me/memberships/{organizationId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}