List all permissions on an organization

GET

/api/v2/organizations/{organization_id}/permissions

Retrieves a list of all users who have permissions on a specific organization.
This endpoint provides a comprehensive view of organization access controls, showing which users can access the organization and their respective roles.

Path Parameters:

organization_id (int): The ID of the organization

Authorization:

Requires manage permission on the organization

Request Headers:

X-Authorization-Consistency-Token (string, optional): Authorization consistency token for read-after-write consistency. Pass the token received from a previous write operation to ensure this read reflects that write.

Returns:

A response containing lists of users with their permissions, including:

Users: user_id, first_name, last_name, email, relations (roles: admin, member, staff),
and permission_sets (permission sets directly assigned to the user; empty when the
permission-sets feature is disabled).

Changelog:

2.1: Added permission_sets to each user.

2.0: Initial version

Current Version:

2.1.0

Request

Path Params

Header Params

Responses

🟢200

application/json

Successfully retrieved organization permissions

Bodyapplication/json

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/organizations//permissions' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "organization_id": 0,
        "organization_name": "string",
        "users": [
            {
                "user_id": "string",
                "first_name": "string",
                "last_name": "string",
                "email": "[email protected]",
                "relations": [
                    "string"
                ],
                "permission_sets": [
                    {
                        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                        "name": "string"
                    }
                ]
            }
        ],
        "total_users": 0
    }
}

Organizations

Get user permissions on a specific organization