Skip to content
Authrim

Get user effective permissions

GET
/api/admin/users/{id}/effective-permissions
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/users/example/effective-permissions \
  --header 'Authorization: Bearer <token>'

Resolves permissions from direct roles and organization memberships for a user.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Effective permissions resolved from direct roles and organization memberships.

Media type application/json
object
user_id
required
string
permissions
required
Array<object>
object
permission
required
string
source
required
string
Allowed values: role organization inherited
source_id
string
source_name
string
granted_at
integer
expires_at
integer
key
additional properties
by_category
required
object
key
additional properties
Array<object>
object
permission
required
string
source
required
string
Allowed values: role organization inherited
source_id
string
source_name
string
granted_at
integer
expires_at
integer
key
additional properties
summary
required
object
total_permissions
required
integer
from_roles
required
integer
from_organizations
required
integer
from_inherited
required
integer
key
additional properties
roles
required
Array<object>
object
key
additional properties
organizations
required
Array<object>
object
key
additional properties
key
additional properties
Example 
{
  "user_id": "user_123",
  "permissions": [
    {
      "permission": "users:read",
      "source": "role",
      "source_id": "role_support",
      "source_name": "Support Agent",
      "granted_at": 1770000000,
      "expires_at": null
    }
  ],
  "by_category": {
    "users": [
      {
        "permission": "users:read",
        "source": "role",
        "source_id": "role_support",
        "source_name": "Support Agent",
        "granted_at": 1770000000,
        "expires_at": null
      }
    ]
  },
  "summary": {
    "total_permissions": 1,
    "from_roles": 1,
    "from_organizations": 0,
    "from_inherited": 0
  },
  "roles": [
    {
      "role_id": "role_support",
      "role_name": "Support Agent",
      "granted_at": 1770000000000,
      "expires_at": null
    }
  ],
  "organizations": [
    {
      "organization_id": "org_123",
      "organization_name": "Example Org",
      "role_id": "role_member",
      "role_name": "member",
      "joined_at": 1770000000000
    }
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}