Hanzo
OpenapiO11y

Returns the calling user together with every role they hold.

Returns the calling user together with every role they hold.

GET /v1/o11y/users/me

Addresshttps://api.hanzo.ai/v1/o11y/users/me
MethodGET
OperationGetMyUser
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the calling user together with every role they hold. Open to any authenticated caller.

Request

GET /v1/o11y/users/me takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200o11y.O11yUserWithRolesOutok

200 body — 24 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yUserWithRoles
data.createdAtbodystring (date-time)CreatedAt is when they joined.
data.displayNamebodystringDisplayName is what the console shows for them.
data.emailbodystringEmail is their address.
data.idbodystringID is the user id.
data.isRootbodybooleanIsRoot marks the org's root user.
data.orgIdbodystringOrgID is the org they belong to.
data.statusbodystringStatus is their lifecycle state — active, pending_invite or deleted.
data.updatedAtbodystring (date-time)UpdatedAt is when their record last changed.
data.userRolesbodyo11y.O11yUserRole[]UserRoles are their role assignments.
data.userRoles[].createdAtbodystring (date-time)CreatedAt is when it was assigned.
data.userRoles[].idbodystringID is the assignment's own id.
data.userRoles[].rolebodyo11y.O11yRole
data.userRoles[].role.createdAtbodystring (date-time)CreatedAt is when the role was created.
data.userRoles[].role.descriptionbodystringDescription says what the role is for.
data.userRoles[].role.idbodystringID is the role id.
data.userRoles[].role.namebodystringName is the role's name.
data.userRoles[].role.orgIdbodystringOrgID is the org the role belongs to.
data.userRoles[].role.typebodystringType is how the role came to be — managed by the platform or custom.
data.userRoles[].role.updatedAtbodystring (date-time)UpdatedAt is when it last changed.
data.userRoles[].roleIdbodystringRoleID is the role held.
data.userRoles[].updatedAtbodystring (date-time)UpdatedAt is when the assignment last changed.
data.userRoles[].userIdbodystringUserID is the user holding the role.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y users me get

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page