Skip to main content
Version: 3.102.2
Version: 2.1.0

User Actions

cidaas User Actions API

These APIs manage:

  • Register new users with optional auto-login
  • Invite new users
  • Add users to or remove users from user groups
  • Purge users
  • Perform bulk user add and update operations
  • Implement webfinger actions for customer's own IDP

The core entities are:

  • UserAccount - describes a user in your system and links user identities
  • UserGroupMap - defines relationships between users and user groups

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

  • cidaas:users_search: allows search for users

  • cidaas:register: allows registration (add) of new users

  • cidaas:users_invite: allows invitation of a new user

  • cidaas:users_read: allows read of user

  • cidaas:users_write: allows update of user

  • cidaas:users_delete: allows deletion of user

  • cidaas:userupdate: allows the user to update its own user profile

  • cidaas:userinfo: allows to read userinfo

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

  • cidaas:users_search: allows search for users

  • cidaas:register: allows registration (add) of new users

  • cidaas:users_invite: allows invitation of a new user

  • cidaas:users_read: allows read of user

  • cidaas:users_write: allows update of user

  • cidaas:users_delete: allows deletion of 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

  • cidaas:users_search: allows search for users

  • cidaas:register: allows registration (add) of new users

  • cidaas:users_invite: allows invitation of a new user

  • cidaas:users_read: allows read of user

  • cidaas:users_write: allows update of user

  • cidaas:users_delete: allows deletion of user

  • cidaas:userupdate: allows the user to update its own user profile

  • cidaas:userinfo: allows to read userinfo