Organizations > User organization roles

User organization roles define user permissions in the organization. The endpoints discussed further retrieve information about user roles in the organization. Use the /users/{userId}/user-organization-roles/{organizationIdId} to manage user organization roles. Check out the overview of user organization roles and the associated user permissions.

List user roles

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/organizations/{organizationId}/user-organization-roles

Retrieves information about all users and their roles in the organization with the specified organizationId.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

organizationIdintegerRequired

The ID of the organization.

Example: 11

Query parameters

colsstring[]Optional

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

Example: {"value":["userId","organizationId","userRoleId","invitation","organizationTeamsCount","joinedTeamsCount"]}

Responses

200

Successful response

application/json

get

/organizations/{organizationId}/user-organization-roles

HTTPcURLJavaScriptPython

GET /api/v2/organizations/{organizationId}/user-organization-roles HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "userOrganizationRoles": [
    {
      "userId": 1,
      "organizationId": 11,
      "usersRoleId": 11,
      "invitation": null
    },
    {
      "userId": 2,
      "organizationId": 11,
      "usersRoleId": 13,
      "invitation": "expired"
    }
  ]
}

Get user organization role details

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/organizations/{organizationId}/user-organization-roles/{userId}

Retrieves information about a user role in an organization with the specified userId and organizationId. Get all user role IDs with the API call GET users/roles.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

organizationIdintegerRequired

The ID of the organization.

Example: 11

userIdintegerRequired

The ID of the user.

Example: 111

Query parameters

colsstring[]Optional

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

Example: {"value":["userId","organizationId","userRoleId","invitation","organizationTeamsCount","joinedTeamsCount"]}

Responses

200

Successful response

application/json

get

/organizations/{organizationId}/user-organization-roles/{userId}

HTTPcURLJavaScriptPython

GET /api/v2/organizations/{organizationId}/user-organization-roles/{userId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "userOrganizationRole": {
    "userId": 111,
    "organizationId": 11,
    "usersRoleId": 11,
    "invitation": null
  }
}

Transfer organization ownership

post

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/organizations/{organizationId}/user-organization-roles/transfer

Transfer organization ownership to the specified user. Only the user that has the user role "Owner" in the organization can transfer ownership.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

organizationIdintegerRequired

The ID of the organization.

Example: 11

Body

application/json

userIdintegerRequired

The ID of the user.

Responses

200

Successful response

application/json

post

/organizations/{organizationId}/user-organization-roles/transfer

HTTPcURLJavaScriptPython

POST /api/v2/organizations/{organizationId}/user-organization-roles/transfer HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "userId": 1
}

200

Successful response

{
  "userOrganizationRoles": [
    {
      "userId": 12,
      "organizationId": 10,
      "usersRoleId": 11,
      "invitation": null
    },
    {
      "userId": 1,
      "organizationId": 10,
      "usersRoleId": 12,
      "invitation": null
    }
  ]
}