List All Permissions on an Organization

GET

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

Lists everyone who holds a role in an organization, with their roles and permission
sets, so an admin can review who has access. An organization role is the standing a
user has in the organization itself: admin, staff or member.

Note:

The whole list comes back in one response, without paging.

Send X-API-Version: 2.1 to get each user without inherited_permission_sets,
or 2.0 to get each user without permission_sets either. The default is 2.2.

Changelog:

2.2.0: Added inherited_permission_sets to each user: the permission sets they get through their teams.

2.1.0: Added permission_sets to each user.

2.0.0: Initial version.

Requires the organization admin or staff role.

Request

Path Params

Header Params

Responses

🟢200

application/json

The organization's users, with their roles and permission sets.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Direct and team-inherited permission sets

{
    "success": true,
    "message": "Organization permissions retrieved successfully",
    "data": {
        "organization_id": 1,
        "organization_name": "Example Org",
        "users": [
            {
                "user_id": "42",
                "first_name": "Jane",
                "last_name": "Doe",
                "email": "[email protected]",
                "relations": [
                    "member"
                ],
                "permission_sets": [
                    {
                        "id": "6f1c2d3e-4b5a-4c7d-8e9f-0a1b2c3d4e5f",
                        "name": "Agent Editors"
                    }
                ],
                "inherited_permission_sets": [
                    {
                        "id": "0b9e8d7c-6a5f-4e3d-2c1b-a09f8e7d6c5b",
                        "name": "Corpus Viewers"
                    }
                ]
            }
        ],
        "total_users": 1
    }
}

Organizations

Get My Organization Permissions