Invites

This document uses the REST API. For more details, see the Authentication for API page.

Invite a user to an organization

Invite a user to an organization with a role.

POSThttps://api.snyk.io/rest/orgs/{org_id}/invites

Path parameters

org_id*string (uuid)

The id of the org the user is being invited to

Query parameters

Body

application/vnd.api+json

data*OrgInvitationPostData (object)

Response

201400401403404500

A new organization invitation has been created

Headers

Body

application/vnd.api+json

data*OrgInvitation20240621 (object)

jsonapi*JsonApi (object)

linksLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/invites?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "org_invitation",
        "attributes": {
          "email": "[e-mail]",
          "role": "f1968726-1dca-42d4-a4dc-80cab99e2b6c"
        }
      }
    }),
});
const data = await response.json();

Response

201400401403404500

{
  "data": {
    "attributes": {
      "email": "[e-mail]",
      "is_active": true,
      "role": "f1968726-1dca-42d4-a4dc-80cab99e2b6c"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "relationships": {
      "org": {
        "data": {
          "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
          "type": "resource"
        },
        "links": {
          "related": {
            "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
          }
        }
      }
    },
    "type": "org_invitation"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

List pending user invitations to an organization.

List pending user invitations to an organization.

GEThttps://api.snyk.io/rest/orgs/{org_id}/invites

Path parameters

org_id*string (uuid)

The id of the org the user is being invited to

Query parameters

Response

200400401403404500

List of pending invitations to an organization.

Headers

Body

application/vnd.api+json

data*array of OrgInvitation (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/invites?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "data": [
    {
      "attributes": {
        "email": "[e-mail]",
        "is_active": true,
        "role": "Developer"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "relationships": {
        "org": {
          "data": {
            "id": "4a72d1db-b465-4764-99e1-ecedad03b06a",
            "type": "resource"
          },
          "links": {
            "related": {
              "href": "https://example.com/api/resource/4a72d1db-b465-4764-99e1-ecedad03b06a"
            }
          }
        }
      },
      "type": "text"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

Cancel a pending user invitations to an organization.

Cancel a pending user invitations to an organization.

DELETEhttps://api.snyk.io/rest/orgs/{org_id}/invites/{invite_id}

Path parameters

org_id*string (uuid)

The id of the org the user is being invited to

invite_id*string (uuid)

The id of the pending invite to cancel

Query parameters

Response

204400401403404500

The operation completed successfully with no content

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/invites/{invite_id}?version=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404500

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}