Endpoints

OpenID Connect 1.0 Discovery

The OpenID Connect Discovery Endpoint is located within the issuer domain. This would give us {your_domain}/.well-known/openid-configuration.

Link to spec. OpenID Connect Discovery 1.0 incorporating errata set 1

authorization_endpoint

{your_domain}/oauth/v2/authorize

note

The authorization_endpoint is located with the login page, due to the need of accessing the same cookie domain

The authorization_endpoint is the starting point for all initial user authentications. The user agent (browser) will be redirected to this endpoint to authenticate the user in exchange for an authorization_code (authorization code flow) or tokens (implicit flow).

Links to specs

• Section 3.1 of OAuth2.0 (RFC6749)
• Section 3.1.2 of OpenID Connect Core 1.0 incorporating errata set 1

Required request parameters

Parameter	Description
client_id	The id of your client as shown in Console.
redirect_uri	Callback uri of the authorization request where the code or tokens will be sent to. Must match exactly one of the preregistered in Console.
response_type	Determines whether a code, id_token token or just id_token will be returned. Most use cases will need code. See flow guide for more info.
scope	openid is required, see Scopes for more possible values. Scopes are space delimited, e.g. openid email profile

info

Following the OIDC Core 1.0 specs whenever an access_token is issued, the id_token will not contain any claims of the scopes profile, email, phone and address.

Send the access_token to the userinfo_endpoint or introspection_endpoint the retrieve these claims or set the id_token_userinfo_assertion Option ("User Info inside ID Token" in Console) to true.

Depending on your authorization method you will have to provide additional parameters or headers:

client_secret_basic

no additional parameters required

client_secret_post

no additional parameters required

none (PKCE)

Parameter	Description
code_challenge	The SHA-256 value of the generated code_verifier
code_challenge_method	Method used to generate the challenge, must be S256

see PKCE guide for more information

private_key_jwt

no additional parameters required

Additional parameters

Parameter	Description
id_token_hint	Valid id_token (of an existing session) used to identity the subject. SHOULD be provided when using prompt none.
login_hint	A valid logon name of a user. Will be used for username inputs or preselecting a user on select_account. Be sure to encode the hint correctly using url encoding (especially when using + or alike in the loginname)
max_age	Seconds since the last active successful authentication of the user
nonce	Random string value to associate the client session with the ID Token and for replay attacks mitigation. MUST be provided when using implicit flow.
prompt	If the Auth Server prompts the user for (re)authentication. no prompt: the user will have to choose a session if more than one session exists none: user must be authenticated without interaction, an error is returned otherwise login: user must reauthenticate / provide a user name select_account: user is prompted to select one of the existing sessions or create a new one create: the registration form will be displayed to the user directly
state	Opaque value used to maintain state between the request and the callback. Used for Cross-Site Request Forgery (CSRF) mitigation as well, therefore highly recommended.
ui_locales	Spaces delimited list of preferred locales for the login UI, e.g. de-CH de en. If none is provided or matches the possible locales provided by the login UI, the accept-language header of the browser will be taken into account.

Successful Code Response

When your response_type was code and no error occurred, the following response will be returned:

Property	Description
code	Opaque string which will be necessary to request tokens on the token endpoint
state	Unmodified state parameter from the request

Successful Implicit Response

When your response_type was either it_token or id_token token and no error occurred, the following response will be returned:

Property	Description
access_token	Only returned if response_type included token
expires_in	Number of second until the expiration of the access_token
id_token	An id_token of the authorized user
token_type	Type of the access_token. Value is always Bearer
scope	Scopes of the access_token. These might differ from the provided scope parameter.
state	Unmodified state parameter from the request

Error Response

Regardless of the authorization flow chosen, if an error occurs the following response will be returned to the redirect_uri.

note

If the redirect_uri is not provided, was not registered or anything other prevents the auth server form returning the response to the client, the error will be display directly to the user on the auth server

Property	Description
error	An OAuth / OIDC error_type
error_description	Description of the error type or additional information of the error
state	Unmodified state parameter from the request

Possible errors

error_type	Possible reason
invalid_request	The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.
invalid_scope	The requested scope is invalid. Typically the required openid value is missing.
unauthorized_client	The client is not authorized to request an access_token using this method. Check in Console that the requested response_type is allowed in your application configuration.
unsupported_response_type	The authorization server does not support the requested response_type.
server_error	The authorization server encountered an unexpected condition that prevented it from fulfilling the request.
interaction_required	The authorization server requires end-user interaction of some form to proceed. This error MAY be returned when the prompt parameter value in the Authentication Request is none, but the Authentication Request cannot be completed without displaying a user interface for end-user interaction.
login_required	The authorization server requires end-user authentication. This error MAY be returned when the prompt parameter value in the Authentication Request is none, but the Authentication Request cannot be completed without displaying a user interface for end-user authentication.

token_endpoint

{your_domain}/oauth/v2/token

The token_endpoint will as the name suggests return various tokens (access, id and refresh) depending on the used grant_type. When using authorization_code flow call this endpoint after receiving the code from the authorization_endpoint. When using refresh_token or urn:ietf:params:oauth:grant-type:jwt-bearer (JWT Profile) you will call this endpoint directly.

Authorization Code Grant (Code Exchange)

As mention above, when using authorization_code grant, this endpoint will be your second request for authorizing a user with its user agent (browser).

Required request Parameters

Parameter	Description
code	Code that was issued from the authorization request.
grant_type	Must be authorization_code
redirect_uri	Callback uri where the code was be sent to. Must match exactly the redirect_uri of the authorization request.

Depending on your authorization method you will have to provide additional parameters or headers:

client_secret_basic

Send your client_id and client_secret as Basic Auth Header. Check Client Secret Basic Auth Method on how to build it correctly.

client_secret_post

Send your client_id and client_secret as parameters in the body:

Parameter	Description
client_id	client_id of the application
client_secret	client_secret of the application

none (PKCE)

Send your code_verifier for us to recompute the code_challenge of the authorization request.

Parameter	Description
code_verifier	code_verifier previously used to generate the code_challenge

private_key_jwt

Send a client assertion as JWT for us to validate the signature against the registered public key.

Parameter	Description
client_assertion	JWT built and signed according to Using JWTs for Client Authentication
client_assertion_type	Must be urn:ietf:params:oauth:client-assertion-type:jwt-bearer

Successful code response

Property	Description
access_token	An access_token as JWT or opaque token
expires_in	Number of second until the expiration of the access_token
id_token	An id_token of the authorized user
scope	Scopes of the access_token. These might differ from the provided scope parameter.
refresh_token	An opaque token. Only returned if offline_access scope was requested
token_type	Type of the access_token. Value is always Bearer

JWT Profile Grant

Required request Parameters

Parameter	Description
grant_type	Must be urn:ietf:params:oauth:grant-type:jwt-bearer
assertion	JWT built and signed according to Using JWTs for Authorization Grants
scope	Scopes you would like to request from ZITADEL. Scopes are space delimited, e.g. openid email profile

curl --request POST \
  --url {your_domain}/oauth/v2/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer \
  --data assertion=eyJhbGciOiJSUzI1Ni...

Successful JWT Profile response

Property	Description
access_token	An access_token as JWT or opaque token
expires_in	Number of second until the expiration of the access_token
id_token	An id_token of the authorized service user
scope	Scopes of the access_token. These might differ from the provided scope parameter.
token_type	Type of the access_token. Value is always Bearer

Refresh Token Grant

To request a new access_token without user interaction, you can use the refresh_token grant. See offline_access Scope for how to request a refresh_token in the authorization request.

Required request Parameters

Parameter	Description
grant_type	Must be refresh_token
refresh_token	The refresh_token previously issued in the last authorization_code or refresh_token request.
scope	Scopes you would like to request from ZITADEL for the new access_token. Must be a subset of the scope originally requested by the corresponding auth request. When omitted, the scopes requested by the original auth request will be reused. Scopes are space delimited, e.g. openid email profile

Depending on your authorization method you will have to provide additional parameters or headers:

client_secret_basic

Send your client_id and client_secret as Basic Auth Header. Check Client Secret Basic Auth Method on how to build it correctly.

client_secret_post

Send your client_id and client_secret as parameters in the body:

Parameter	Description
client_id	client_id of the application
client_secret	client_secret of the application

none (PKCE)

Send your client_id as parameter in the body. No authentication is required.

private_key_jwt

Send a client_assertion as JWT for us to validate the signature against the registered public key.

Parameter	Description
client_assertion	JWT built and signed according to Using JWTs for Client Authentication
client_assertion_type	Must be urn:ietf:params:oauth:client-assertion-type:jwt-bearer

Successful refresh token response

Property	Description
access_token	An access_token as JWT or opaque token
expires_in	Number of second until the expiration of the access_token
id_token	An id_token of the authorized user
scope	Scopes of the access_token. These might differ from the provided scope parameter.
refresh_token	An new opaque refresh_token.
token_type	Type of the access_token. Value is always Bearer

Client Credentials Grant

Required request Parameters

Parameter	Description
grant_type	Must be client_credentials
scope	Scopes you would like to request from ZITADEL. Scopes are space delimited, e.g. openid profile

Additionally, you need to authenticate your client by either sending client_id and client_secret as Basic Auth Header. Check Client Secret Basic Auth Method on how to build it correctly.

curl --request POST \
  --url {your_domain}/oauth/v2/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Authorization: Basic ${BASIC_AUTH}' \
  --data grant_type=client_credentials \
  --data scope=openid profile

Or you can also send your client_id and client_secret as parameters in the body:

Parameter	Description
client_id	client_id of the application
client_secret	client_secret of the application

curl --request POST \
  --url {your_domain}/oauth/v2/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials \
  --data client_id=${CLIENT_ID} \
  --data client_secret=${CLIENT_SECRET} \
  --data scope=openid profile

Successful Client Credentials response

Property	Description
access_token	An access_token as JWT or opaque token
expires_in	Number of second until the expiration of the access_token
scope	Scopes of the access_token. These might differ from the provided scope parameter.
token_type	Type of the access_token. Value is always Bearer

Error response

error_type	Possible reason
invalid_request	The request is missing a required parameter, includes an unsupported parameter value (other than grant type), repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the client, or is otherwise malformed.
invalid_scope	The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.
unauthorized_client	The authenticated client is not authorized to use this authorization grant type.
unsupported_grant_type	The authorization grant type is not supported by the authorization server.
server_error	The authorization server encountered an unexpected condition that prevented it from fulfilling the request.
invalid_grant	The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
invalid_client	Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method).

introspection_endpoint

{your_domain}/oauth/v2/introspect

This endpoint enables clients to validate an acccess_token, either opaque or JWT. Unlike client side JWT validation, this endpoint will check if the token is not revoked (by client or logout).

Parameter	Description
token	An access token

Depending on your authorization method you will have to provide additional parameters or headers:

client_secret_basic

Send your client_id and client_secret as Basic Auth Header. Check Client Secret Basic Auth Method on how to build it correctly.

curl --request POST \
  --url {your_domain}/oauth/v2/introspect \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Authorization: Basic {your_basic_auth_header}' \
  --data token=VjVxyCZmRmWYqd3_F5db9Pb9mHR5fqzhn...

private_key_jwt

Send a client_assertion as JWT for us to validate the signature against the registered public key.

Parameter	Description
client_assertion	JWT built and signed according to Using JWTs for Client Authentication
client_assertion_type	must be urn:ietf:params:oauth:client-assertion-type:jwt-bearer

curl --request POST \
  --url {your_domain}/oauth/v2/introspect \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer \
  --data client_assertion=eyJhbGciOiJSUzI1Ni... \
  --data token=VjVxyCZmRmWYqd3_F5db9Pb9mHR5fqzhn...

Successful introspection response

Upon successful authorization of the client a response with the boolean active is returned, indicating if the provided token is active and the requesting client is part of the token audience.

If active is true, further information will be provided:

Property	Description
aud	The audience of the token
client_id	The client_id of the application the token was issued to
exp	Time the token expires (as unix time)
iat	Time of the token was issued at (as unix time)
iss	Issuer of the token
jti	Unique id of the token
nbf	Time the token must not be used before (as unix time)
scope	Space delimited list of scopes granted to the token
token_type	Type of the inspected token. Value is always Bearer
username	ZITADEL's login name of the user. Consist of username@primarydomain

Additionally and depending on the granted scopes, information about the authorized user is provided. Check the Claims page if a specific claims might be returned and for detailed description.

Error response

If the authorization fails, an HTTP 401 with invalid_client will be returned.

userinfo_endpoint

{your_domain}/oidc/v1/userinfo

This endpoint will return information about the authorized user.

Send the access_token of the user (not the client) as Bearer Token in the authorization header:

curl --request GET \
  --url {your_domain}/oidc/v1/userinfo
  --header 'Authorization: Bearer dsfdsjk29fm2as...'

Successful userinfo response

If the access_token is valid, the information about the user depending on the granted scopes is returned. Check the Claims page if a specific claims might be returned and for detailed description.

Error response

If the token is invalid or expired, an HTTP 401 will be returned.

revocation_endpoint

{your_domain}/oauth/v2/revoke

This endpoint enables clients to revoke an access_token or refresh_token they have been granted.

info

If you revoke an access_token only the specific token will be revoked. When revoking a refresh_token, the corresponding access_token will be revoked as well.

Parameter	Description
token	An access token or refresh token

Depending on your authorization method you will have to provide additional parameters or headers:

client_secret_basic

Send your client_id and client_secret as Basic Auth Header. Check Client Secret Basic Auth Method on how to construct a request correctly.

client_secret_post

Send your client_id and client_secret as parameters in the body:

Parameter	Description
client_id	client_id of the application
client_secret	client_secret of the application

none (PKCE)

Send your client_id as parameters in the body:

Parameter	Description
client_id	client_id of the application

private_key_jwt

Send a client_assertion as JWT for ZITADEL to verify the signature against the registered public key.

Parameter	Description
client_assertion	JWT created and signed according to Using JWTs for Client Authentication
client_assertion_type	must be urn:ietf:params:oauth:client-assertion-type:jwt-bearer

curl --request POST \
  --url {your_domain}/oauth/v2/revoke \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer \
  --data client_assertion=eyJhbGciOiJSUzI1Ni... \
  --data token=VjVxyCZmRmWYqd3_F5db9Pb9mHR5fqzhn...

end_session_endpoint

{your_domain}/oidc/v1/end_session

The endpoint has to be opened in the user agent (browser) to terminate the user sessions.

No parameters are needed apart from the user agent cookie, but you can provide the following to customize the behaviour:

Parameter	Description
id_token_hint	the id_token that was previously issued to the client
client_id	client_id of the application
post_logout_redirect_uri	Callback uri of the logout where the user (agent) will be redirected to. Must match exactly one of the preregistered in Console.
state	Opaque value used to maintain state between the request and the callback

The post_logout_redirect_uri will be checked against the previously registered uris of the client provided by the azp claim of the id_token_hint or the client_id parameter. If both parameters are provided, they must be equal.

jwks_uri

{your_domain}/oauth/v2/keys

Be aware that these keys can be rotated without any prior notice. We will however make sure that a proper kid is set with each key!

OAuth 2.0 Metadata

ZITADEL does not yet provide a OAuth 2.0 Metadata endpoint but instead provides a OpenID Connect Discovery Endpoint.