Tenants
Get a list of all Tenants which the calling user is a member of
API key value must be prefixed with "Token ".
Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Number of results to return per page
10Example: 10Returns a list of tenants.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/tenants?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"created_at": "2022-03-16T00:00:00Z",
"name": "My Tenant",
"slug": "my-tenant",
"updated_at": "2022-03-16T00:00:00Z"
},
"id": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
"relationships": {
"owner": {
"data": {
"id": "b667f176-df52-4b0a-9954-117af6b05ab7",
"type": "user"
}
}
},
"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 the details of a tenant
Required permissions
Edit Tenant Details (tenant.edit)
API key value must be prefixed with "Token ".
Unique identifier for tenant
b667f176-df52-4b0a-9954-117af6b05ab7Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Instance of tenant is updated
The operation completed successfully with no content
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
PATCH /rest/tenants/{tenant_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 106
{
"data": {
"attributes": {
"name": "My Tenant"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "resource"
}
}{
"data": {
"attributes": {
"created_at": "2022-03-16T00:00:00Z",
"name": "My Tenant",
"slug": "my-tenant",
"updated_at": "2022-03-16T00:00:00Z"
},
"id": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2",
"type": "resource"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https://example.com/api/this_resource"
}
}Get the full details of a Tenant.
Required permissions
View Tenant Details (tenant.read)
API key value must be prefixed with "Token ".
Unique identifier for tenant
b667f176-df52-4b0a-9954-117af6b05ab7Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Returns an instance of a tenant.
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/tenants/{tenant_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"attributes": {
"created_at": "2022-03-16T00:00:00Z",
"name": "My Tenant",
"slug": "my-tenant",
"updated_at": "2022-03-16T00:00:00Z"
},
"id": "59d6d97e-3106-4ebb-b608-352fad9c5b34",
"relationships": {
"owner": {
"data": {
"id": "b667f176-df52-4b0a-9954-117af6b05ab7",
"type": "user"
}
}
},
"type": "resource"
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https://example.com/api/this_resource"
}
}Returns all memberships of the tenant
Required permissions
View Tenant Memberships (tenant.membership.read)
API key value must be prefixed with "Token ".
Unique identifier for a tenant.
00000000-0000-0000-0000-000000000000Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=Number of results to return per page
10Example: 10Which column to sort by.
Order in which results are returned.
ASCExample: ASCPossible values: Filter the response by Users that match the provided email
Unique identifier for a user.
00000000-0000-0000-0000-000000000000Filter the response by Users that match the provided name
Filter the response by Users that match the provided username
Filter the response by Users that match the provided connection type
Filter the response for results only with the specified role.
List of tenant memberships is returned
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Internal Server Error: An error was encountered while attempting to process the request.
GET /rest/tenants/{tenant_id}/memberships?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"attributes": {
"created_at": "2022-03-16T00:00:00Z"
},
"id": "00000000-0000-0000-0000-000000000000",
"relationships": {
"role": {
"data": {
"attributes": {
"name": "Role name"
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "tenant_role"
}
},
"tenant": {
"data": {
"attributes": {
"name": "My Tenant"
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "tenant"
}
},
"user": {
"data": {
"attributes": {
"account_type": "user",
"active": true,
"email": "[email protected]",
"login_method": "saml",
"name": "Firstname Lastname",
"username": "username"
},
"id": "00000000-0000-0000-0000-000000000000",
"meta": {
"tenant_owner": true
},
"type": "user"
}
}
},
"type": "tenant_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"
}
}Update the tenant membership with the new role
Required permissions
-
View Tenant Details (tenant.read) -
View Tenant Memberships (tenant.membership.read) -
Edit Tenant Memberships (tenant.membership.edit)
API key value must be prefixed with "Token ".
Unique identifier for a tenant.
00000000-0000-0000-0000-000000000000Unique identifier for a tenant membership.
00000000-0000-0000-0000-000000000000Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$successfully updated the tenant membership
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
PATCH /rest/tenants/{tenant_id}/memberships/{membership_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 198
{
"data": {
"attributes": {},
"id": "00000000-0000-0000-0000-000000000000",
"relationships": {
"role": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "tenant_role"
}
}
},
"type": "tenant_membership"
}
}No content
Delete an individual tenant membership for a single user.
Required permissions
-
View Tenant Memberships (tenant.membership.read) -
tenant.membership.delete
API key value must be prefixed with "Token ".
Unique identifier for a tenant membership.
00000000-0000-0000-0000-000000000000Unique identifier for a tenant.
00000000-0000-0000-0000-000000000000Requested API version
2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$successfully deleting an individual membership for a single user
Bad Request: A parameter provided as a part of the request was invalid.
Unauthorized: the request requires an authentication token.
Forbidden: the request requires an authentication token with more or different permissions.
Not Found: The resource being operated on could not be found.
Conflict: The requested operation conflicts with the current state of the resource in some way.
Internal Server Error: An error was encountered while attempting to process the request.
DELETE /rest/tenants/{tenant_id}/memberships/{membership_id}?version=text HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?