Users > User organization roles

The following endpoints update and retrieve data about user organization roles of a user in an organization. Check out the overview of user organization roles and the associated permissions.

List user roles in an organization

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

/users/{userId}/user-organization-roles

Gets list of all users and their roles in the organization with the specified 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

userIdstringRequired

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","usersRoleId","invitation","organizationTeamsCount","joinedTeamsCount"]}

Responses

200

Successful response

application/json

get

/users/{userId}/user-organization-roles

HTTPcURLJavaScriptPython

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

200

Successful response

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

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

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

Gets information about 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

userIdstringRequired

The ID of the user

Example: 254

organizationIdstringRequired

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

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

HTTPcURLJavaScriptPython

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

200

Successful response

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

Update user role

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

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

Updates the specified user role in the organization. Only organization owners and admins can change the user organization roles. Refer to the Make Help center for a breakdown of the user role permissions.

Specify the ID of the new role for the user in the request body. Get all available user role IDs and the corresponding user role names with the API call GET /users/roles.

You cannot change the organization "Owner" with this endpoint. Use the API call to transfer organization ownership instead.

If you send an empty request body, the user with the specified userId will be removed from the organization.

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

userIdintegerRequired

The ID of the user.

Example: 5

organizationIdintegerRequired

The ID of the organization.

Example: 22

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","usersRoleId","invitation","organizationTeamsCount","joinedTeamsCount"]}

confirmedbooleanOptional

Use this parameter when you are removing a user from an organization. Set this parameter to true is you want to delete the user's connections from the organization with the parameter deleteConnections.

Example: {"value":true}

deleteConnectionsbooleanOptional

Set this parameter to true if you are removing a user from an organization to delete also the user's connections. If you set this parameter to false, the API call won't delete the user's connections.

Example: {"value":true}

Body

application/json

usersRoleIdintegerOptional

The ID of the user role. Check the GET /users/roles API call for the available usersRoleId values.

Responses

200

Successful response

application/json

post

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

HTTPcURLJavaScriptPython

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

{
  "usersRoleId": 12
}

Set user roleSet user data all colsRemove user from organization

200

Successful response

{
  "userOrganizationRole": {
    "userId": 5,
    "organizationId": 22,
    "usersRoleId": 12,
    "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

/users/{userId}/user-organization-roles/{organizationId}/transfer

Transfer organization ownership to the user with the specified userId. Only organization owner can transfer their ownership to another user.

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

userIdintegerRequired

The ID of the user.

Example: 111

organizationIdintegerRequired

The ID of the organization.

Example: 11

Responses

200

Successful response

application/json

post

/users/{userId}/user-organization-roles/{organizationId}/transfer

HTTPcURLJavaScriptPython

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

200

Successful response

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