Objects
External User​
externalId
string
User id from the identity providerexternalIdpId
string
Id of the identity providerhuman
firstName
stringlastName
stringnickName
stringdisplayName
stringpreferredLanguage
string
In RFC 5646 fromatemail
stringisEmailVerified
booleanphone
stringisPhoneVerified
boolean
metadata with value as bytes​
key
stringvalue
Array of byte
metadata result​
count
numbersequence
numbertimestamp
Datemetadata
Array of metadata
metadata​
creationDate
DatechangeDate
DateresourceOwner
stringsequence
numberkey
stringvalue
Any
user grant​
projectID
string
Required. Id of the project to be grantedprojectGrantID
string
Optional. If the grant is for a project grant, include projectGrantIDroles
Array of string
Containing the roles
user​
id
stringcreationDate
DatechangeDate
DateresourceOwner
stringsequence
number
Unsigned 64 bit integerstate
number- 0: unspecified
- 1: active
- 2: inactive
- 3: deleted
- 4: locked
- 5: suspended
- 6: initial
username
stringloginNames
Array of stringpreferredLoginName
stringhuman
Set if the user is humanfirstName
stringlastName
stringnickName
stringdisplayName
stringavatarKey
stringpreferredLanguage
string
In RFC 5646 fromatgender
number- 0: unspecified
- 1: female
- 2: male
- 3: diverse
email
stringisEmailVerified
booleanphone
stringisPhoneVerified
boolean
machine
Set if the user is a machinename
stringdescription
string
human user​
id
stringcreationDate
DatechangeDate
DateresourceOwner
stringsequence
numberstate
number- 0: unspecified
- 1: active
- 2: inactive
- 3: deleted
- 4: locked
- 5: suspended
- 6: initial
username
stringloginNames
Array of stringpreferredLoginName
stringprofile
firstName
stringlastName
stringnickName
stringdisplayName
stringpreferredLanguage
string
In RFC 5646 fromat
email
email
stringisEmailVerified
boolean
phone
phone
stringisPhoneVerified
boolean
Auth Request​
This object contains context information about the request to the authorization endpoint.
id
stringagentId
stringcreationDate
DatechangeDate
DatebrowserInfo
browserInfouserAgent
stringacceptLanguage
stringremoteIp
string
applicationId
stringcallbackUri
stringtransferState
stringprompt
Array of Number- 0: not specified
- 1: none
- 2: login
- 3: consent
- 4: select_account
- 5: create
uiLocales
Array of stringloginHint
stringmaxAuthAge
Number
Duration in nanosecondsinstanceId
stringrequest
oidc
scopes
Array of string
userId
stringuserName
stringloginName
stringdisplayName
stringresourceOwner
stringrequestedOrgId
stringrequestedOrgName
stringrequestedPrimaryDomain
stringrequestedOrgDomain
boolapplicationResourceOwner
stringprivateLabelingSetting
Number- 0: Unspecified
- 1: Enforce project resource owner policy
- 2: Allow login user resource owner policy
selectedIdpConfigId
stringlinkingUsers
Array of ExternalUserpasswordVerified
boolmfasVerified
Array of Number- 0: OTP
- 1: U2F
- 2: U2F User verification
audience
Array of stringauthTime
Date
HTTP Request​
This object is based on the Golang struct http.Request, some attributes are removed as not all provided information is usable in this context.
method
stringurl
stringproto
stringcontentLength
numberhost
stringform
Map string of Array of stringpostForm
Map string of Array of stringremoteAddr
stringheaders
Map string of Array of string
Claims​
This object represents the claims which will be written into the oidc token.
sub
stringname
stringemail
stringlocale
stringgiven_name
stringfamily_name
stringpreferred_username
stringemail_verified
boolupdated_at
Number
Additionally there could additional fields depending on the configuration of your project and your application
user grant list​
This object represents a list of user grant stored in ZITADEL.
count
Numbersequence
Numbertimestamp
Dategrants
Array ofid
stringprojectGrantId
string
The id of the project grantstate
Number- 0: unspecified
- 1: active
- 2: inactive
- 3: removed
creationDate
DatechangeDate
Datesequence
NumberuserId
stringroles
Array of stringuserResourceOwner
string
The id of the organization of the useruserGrantResourceOwner
string
The id of the organization, where the user was granteduserGrantResourceOwnerName
string
The name of the organization, where the user was grantedprojectId
stringprojectName
stringgetOrgMetadata()
metadataResult
Get the metadata of the organization where the user was granted