Skip to main content
Version: 2.1.0

Authentication

Authentication is the process of verifying a user's identity using credentials or other authentication methods. Once authentication is successfully completed and validated, the process of authorization begins — determining what actions or resources the authenticated user is permitted to access.

In cidaas, every API endpoint requires a valid and active Access Token to perform API operations (except the public endpoints). This Access Token is a unique, time-bound string that confirms the user's authentication and grants secure access to the API resources.

You can learn more about cidaas authentication from our exclusive documentation.

Authentication

Security Scheme Type:

oauth2

OAuth Flow (authorizationCode):

Scopes:

  • openid: openid scope to generate an id_token which requires read access to users

  • profile: openid scope profile to have access to user profile

  • email: openid scope email to have access to user's email and email_verified claims

  • phone: openid scope phone to have access to user's phone_number and phone_number_verified claims

  • address: openid scope to access user's address

  • identities: allows access to identity claims of an user

OAuth Flow (clientCredentials):

Scopes:

  • openid: openid scope to generate an id_token which requires read access to users

  • profile: openid scope profile to have access to user profile

  • email: openid scope email to have access to user's email and email_verified claims

  • phone: openid scope phone to have access to user's phone_number and phone_number_verified claims

  • address: openid scope to access user's address

  • identities: allows access to identity claims of an user

OAuth Flow (implicit):

Scopes:

  • openid: openid scope to generate an id_token which requires read access to users

  • profile: openid scope profile to have access to user profile

  • email: openid scope email to have access to user's email and email_verified claims

  • phone: openid scope phone to have access to user's phone_number and phone_number_verified claims

  • address: openid scope to access user's address

  • identities: allows access to identity claims of an user