Quick Start Guide

Add a Key Add a Personal Access Token Add a Users Secret Add link to an identity provider to an user Add OTP Email for a user Add OTP SMS for a user Change password Change the user email Create a new User (Human)Create a passkey registration link for a user Create a User Create an invite code for a user Deactivate user Delete the user phone Delete user Delete User Metadata Generate single-use recovery codes for a user List all possible authentication methods of a user List links to an identity provider of an user List passkeys of an user List User Metadata ListAuthenticationFactors Lock user MFA Init Skipped Reactivate user Remove a Key Remove a Personal Access Token Remove a Users Secret Remove link of an identity provider to an user Remove OTP Email from a user Remove OTP SMS from a user Remove passkey from a user Remove recovery codes from a user Remove TOTP generator from a user Remove u2f token from a user Request a code to reset a password Resend an invite code for a user Resend code to verify user phone number ResendEmailCode Retrieve the information returned by the identity provider Search Keys Search Personal Access Tokens Search Users SendEmailCode Set the user phone Set User Metadata Start flow with an identity provider Start the registration of a TOTP generator for a user Start the registration of a u2f token for a user Start the registration of passkey for a user Unlock user Update a User Update User (Human)User by ID Verify a passkey for a user Verify a TOTP generator for a user Verify a u2f token for a user Verify an invite code for a user Verify the email Verify the phone number

Identity Provider

Role Assignments

ZITADEL Internal Permissions

gRPC Status Codes Rate Limits (Cloud)

APIsCore ResourcesV2

User API

API Reference for User

Terminology Update: We have streamlined our naming conventions to improve clarity. The term User has been replaced with User. To avoid breaking changes the APIs still make use of the old term. Both terms refer to the same underlying functionality.

Was this page helpful?

Overview

Explore ZITADEL's APIs for authentication and authorization. Integrate identity management using OpenID Connect, OAuth 2.0, and SAML standards.

Add a Key

Add a Key: Add a keys that can be used to securely authenticate at the Zitadel APIs using JWT profile authentication using short-lived tokens. Make sure you store the returned key safely, as you won't be able...