Roles

Get User Role

The role one person holds in this organisation.

404 when they hold none - which is a real state, not an error: a member can exist in the organisation with no role assigned yet.

The WRITE twin, PUT /v1/roles/users/{user_id}, is not published. It maps a role slug of owner or admin onto the identity provider's own Owner/Admin and syncs it, so it can make somebody an administrator of the tenant.

get/roles/users/{user_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/roles/users/{user_id}
  • Auth: HTTP bearer

Path parameters

user_idstring required

Identity-provider user id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataOrgPayload required

An open envelope for a single role, team, member or account record.

Open on purpose. The app's own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as "they do not have it".

Changes

No recorded changes to this operation across all 3 revisions of this API.