Skip to main content
GET
Describe a User (Relationship ID)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policy_user
string
required

Policy User ID

Response

PolicyUserDetailedResponseData

id
string
required

The ID of the PolicyUser relationship (not the User)

Example:

"pousr_01hq8xyzabc123def456ghi789"

state
enum<string>
required

The state of the Policy User relationship (not the User)

Available options:
staged,
active,
expiring,
expired,
deactivated
timestamp
TimestampStateData · object
required

The timestamps for the policy user record

count
object
required

Count of related records

included
object
required

Included related resources

API hyperlinks related to the policy user record

Example: