Skip to content
Get External User Details

Get External User Details

Get details of a specific user within a project by external user ID.

Endpoint

/api/v1/projects/{project_id}/users/external/{external_user_id}

Method

GET

Path Parameters

ParameterTypeRequiredDescription
project_idstringYesUnique ID of the project
external_user_idstringYesExternal user ID

Headers

HeaderRequiredDescription
AuthorizationYesBearer access token: Bearer <access_token>

Query Parameters

ParameterTypeRequiredDescription
include_permissionsbooleanNoInclude user permissions (default: false)

Required Permission

users:read

Examples

curl --request GET \
  --url https://auth.roled.io/api/v1/projects/2JUSLUee46xG6iEwG8JwPc/users/external/a1d6f9d3dda5?include_permissions=true \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJo...'

Error Codes

CodeHTTP StatusDescription
invalid_authorization_token401Unauthorized request. The authorization token is missing or invalid.
insufficient_permission403Insufficient permissions to access this resource.
user_not_found404The requested user could not be found. in this project
project_not_found404The requested project could not be found.
system_error500An unexpected error occurred. Please try again later.