Orgs

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

List accessible organizations

Get a paginated list of organizations you have access to.

GEThttps://api.snyk.io/rest/orgs

Query parameters

Response

200400401403404500

A list of organizations you have access to.

Headers

Body

application/vnd.api+json

data*array of OrgWithRelationships (object)

jsonapi*JsonApi (object)

links*PaginatedLinks (object)

Request

JavaScriptCurlPython

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

Response

200400401403404500

{
  "data": [
    {
      "attributes": {
        "access_requests_enabled": false,
        "created_at": "2022-03-16T00:00:00Z",
        "group_id": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
        "is_personal": true,
        "name": "My Org",
        "slug": "my-org",
        "updated_at": "2022-03-16T00:00:00Z"
      },
      "id": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
      "relationships": {
        "member_role": {
          "data": {
            "attributes": {
              "name": "Collaborator"
            },
            "id": "f60ff965-6889-4db2-8c86-0285d62f35ab",
            "type": "resource"
          }
        }
      },
      "type": "resource"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
    "last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
    "next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
  }
}

Update organization

Update the details of an organization

PATCHhttps://api.snyk.io/rest/orgs/{org_id}

Path parameters

org_id*string (uuid)

Unique identifier for org

Example: "b667f176-df52-4b0a-9954-117af6b05ab7"

Query parameters

Body

application/vnd.api+json

data*object

Response

200204400401403404409500

Instance of org is updated

Headers

Body

application/vnd.api+json

dataobject

org resource object

jsonapiJsonApi (object)

linksSelfLink (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}?version=text', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "org",
        "attributes": {
          "name": "My Org"
        }
      }
    }),
});
const data = await response.json();

Response

200400401403404409500

{
  "data": {
    "attributes": {
      "access_requests_enabled": false,
      "created_at": "2022-03-16T00:00:00Z",
      "group_id": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
      "is_personal": true,
      "name": "My Org",
      "slug": "my-org",
      "updated_at": "2022-03-16T00:00:00Z"
    },
    "id": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2",
    "relationships": {
      "member_role": {
        "data": {
          "attributes": {
            "name": "Collaborator"
          },
          "id": "f60ff965-6889-4db2-8c86-0285d62f35ab",
          "type": "resource"
        }
      }
    },
    "type": "org"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Create a org membership for a user with role

Create a org membership for a user with role

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

Path parameters

org_id*string (uuid)

The ID of the org

Query parameters

Body

application/vnd.api+json

dataobject

Response

201400401403404409500

Membership for the user is created on the org

Headers

Body

application/vnd.api+json

dataOrgMembership (object)

jsonapiJsonApi (object)

linksLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/memberships?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400401403404409500

{
  "data": {
    "attributes": {
      "created_at": "2021-05-29T09:50:54.014Z"
    },
    "id": "331ede0a-de94-456f-b788-166caeca58bf",
    "relationships": {
      "org": {
        "data": {
          "attributes": {
            "name": "Example org"
          },
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "org"
        }
      },
      "role": {
        "data": {
          "attributes": {
            "name": "Admin role"
          },
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "org_role"
        }
      },
      "user": {
        "data": {
          "attributes": {
            "email": "[e-mail]",
            "login_method": "text",
            "name": "User2",
            "username": "User name 2"
          },
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "user"
        }
      }
    },
    "type": "org_membership"
  },
  "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"
  }
}

Get all memberships of the org

Returns all memberships of the org

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

Path parameters

org_id*string (uuid)

The ID of the org

Query parameters

Response

200400401403404500

List of org memberships is returned

Headers

Body

application/vnd.api+json

data*OrgMembershipResponseData (array of object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

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

Response

200400401403404500

{
  "data": [
    {
      "attributes": {
        "created_at": "2022-03-16T00:00:00Z"
      },
      "id": "331ede0a-de94-456f-b788-166caeca58bf",
      "relationships": {
        "org": {
          "data": {
            "attributes": {
              "name": "Example org"
            },
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "org"
          }
        },
        "role": {
          "data": {
            "attributes": {
              "name": "Admin role"
            },
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "org_role"
          }
        },
        "user": {
          "data": {
            "attributes": {
              "email": "[e-mail]",
              "login_method": "text",
              "name": "User2",
              "username": "User name 2"
            },
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "user"
          }
        }
      },
      "type": "org_memberships"
    }
  ],
  "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"
  }
}

Update a org membership for a user with role

Update a org membership for a user with role

PATCHhttps://api.snyk.io/rest/orgs/{org_id}/memberships/{membership_id}

Path parameters

org_id*string (uuid)

The id of the org

membership_id*string (uuid)

The id of the org membership

Query parameters

Body

application/vnd.api+json

dataUpdateOrgMembershipRequestBody (object)

Response

204400401403404409500

The Membership is updated

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/memberships/{membership_id}?version=text', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500

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

Remove user's org membership

Remove a user's membership of the group.

DELETEhttps://api.snyk.io/rest/orgs/{org_id}/memberships/{membership_id}

Path parameters

org_id*string (uuid)

The id of the org

membership_id*string (uuid)

The id of the org membership

Query parameters

Response

204400401403404500

Org membership for the user was successfully deleted.

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/memberships/{membership_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"
  }
}

List all organizations in group

Get a paginated list of all the organizations belonging to the group. By default, this endpoint returns the organizations in alphabetical order of their name.

GEThttps://api.snyk.io/rest/groups/{group_id}/orgs

Path parameters

group_id*string (uuid)

Unique identifier for group

Example: "b667f176-df52-4b0a-9954-117af6b05ab7"

Query parameters

Response

200400401403404500

A list of organizations in the group.

Headers

Body

application/vnd.api+json

data*array of object

jsonapi*JsonApi (object)

links*PaginatedLinks (object)

Request

JavaScriptCurlPython

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

Response

200400401403404500

{
  "data": [
    {
      "attributes": {
        "access_requests_enabled": false,
        "created_at": "2022-03-16T00:00:00Z",
        "group_id": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
        "is_personal": true,
        "name": "My Org",
        "slug": "my-org",
        "updated_at": "2022-03-16T00:00:00Z"
      },
      "id": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
      "type": "resource"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
    "last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
    "next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
  }
}