Get all User Permissions

GET

/api/v2/users/{user_id}/permissions

Retrieves user permissions based on the provided user ID.

Path Parameters:

user_id: The ID of the user to fetch permissions for.

Request Headers:

Organization-Id (int, optional): Scope the permission-set read to
another organization — effective_permissions / permission_sets are
computed against it once organization-scope enforcement is enabled.
The caller must have organization membership; inaccessible and unknown
IDs are denied without falling back to another organization.

X-Authorization-Consistency-Token (string, optional): Authorization
consistency token for read-after-write consistency.

Authorization:

Users may always read their own permissions,
including in another org via Organization-Id.

Reading another user's permissions requires global admin access on
the org the read is scoped to (403 otherwise).

Returns:

200 OK: The user permissions are retrieved successfully. When the
permission-sets feature flag is enabled, data also carries
effective_permissions — the union of assistant (agent) scopes granted
by every permission set that reaches the user (assigned directly or
inherited via team membership; e.g. edit: ["project", "team"] means
the user can edit assistants in projects they access AND assistants
shared with admin access with their teams, while all subsumes every
other scope) — and permission_sets, the contributing sets with their
source (direct or team).

400 Bad Request: If versioning fails or invalid parameters are passed.

404 Not Found: If the user does not exist.

Current Version: 2.0.0

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/users//permissions' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "user_permissions": [
            {
                "organization": {
                    "id": 0,
                    "org_name": "string",
                    "domain": "string"
                },
                "permission": "string"
            }
        ],
        "effective_permissions": {
            "agents": {
                "view": [
                    "all"
                ],
                "edit": [
                    "all"
                ],
                "delete": [
                    "all"
                ],
                "publish": [
                    "all"
                ],
                "create": true
            },
            "corpora": {
                "view": [
                    "all"
                ],
                "edit": [
                    "all"
                ],
                "delete": [
                    "all"
                ],
                "create": true
            },
            "workflows": {
                "view": [
                    "all"
                ],
                "edit": [
                    "all"
                ],
                "delete": [
                    "all"
                ],
                "create": true
            }
        },
        "legacy_permissions": {
            "agents": {
                "view": [
                    "all"
                ],
                "edit": [
                    "all"
                ],
                "delete": [
                    "all"
                ],
                "publish": [
                    "all"
                ],
                "create": true
            },
            "corpora": {
                "view": [
                    "all"
                ],
                "edit": [
                    "all"
                ],
                "delete": [
                    "all"
                ],
                "create": true
            },
            "workflows": {
                "view": [
                    "all"
                ],
                "edit": [
                    "all"
                ],
                "delete": [
                    "all"
                ],
                "create": true
            }
        },
        "permission_sets": [
            {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "name": "string",
                "source": "direct",
                "team": {
                    "id": 0,
                    "name": "string"
                },
                "permissions": {
                    "agents": {
                        "view": "all",
                        "edit": "all",
                        "delete": "all",
                        "publish": "all",
                        "create": true
                    },
                    "corpora": {
                        "view": "all",
                        "edit": "all",
                        "delete": "all",
                        "create": true
                    },
                    "workflows": {
                        "view": "all",
                        "edit": "all",
                        "delete": "all",
                        "create": true
                    }
                }
            }
        ]
    }
}

Assign a user to multiple permission sets

Create a new User Organization Permission