Skip to main content

User Grant By ID​

Returns a user grant per ID. A user grant is a role a user has for a specific project and organization.

Path Parameters
    userId string required
    grantId string required
Header Parameters
    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

Responses

A successful response.

Schema
    userGrant object
    id string
    details object
    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to
    roleKeys string[]
    state string

    Possible values: [USER_GRANT_STATE_UNSPECIFIED, USER_GRANT_STATE_ACTIVE, USER_GRANT_STATE_INACTIVE]

    Default value: USER_GRANT_STATE_UNSPECIFIED

    current state of the user

    userId string
    userName string
    firstName string
    lastName string
    email string

    email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)

    displayName string

    display name of the user

    orgId string
    orgName string
    orgDomain string
    projectId string
    projectName string
    projectGrantId string
    avatarUrl string

    avatar URL of the user

    preferredLoginName string
    userType string

    Possible values: [TYPE_UNSPECIFIED, TYPE_HUMAN, TYPE_MACHINE]

    Default value: TYPE_UNSPECIFIED

    type of the user (human / machine)

    grantedOrgId string
    grantedOrgName string
    grantedOrgDomain string
Loading...