Skip to main content
Version: cidaas 3.102.2
Version: 1.0

Field Settings API

Field Setup API

The Field Setup is a feature of cidaas to have full flexibility to add further fields that should be stored at a user's profile. These fields can either be mandatory or optional at the app level to ensure all required fields are collected from the user and to support for dynamic rendering of registration or progressive User Interfaces. This API is used to get all the registration fields available for your instance.

The APIs are meant to be retrieved in an unauthorized state e.g. for rendering registration pages whereas the add or update APIs are secured by the OAuth2 Standard.

Authentication

Security Scheme Type:

oauth2

OAuth Flow (authorizationCode):

Scopes:

  • cidaas:field_setup_read: The read access for the field setup

  • cidaas:field_setup_write: The write access for field setups

  • cidaas:field_setup_delete: delete access for field setups

OAuth Flow (clientCredentials):

Scopes:

  • cidaas:field_setup_read: The read access for the field setup

  • cidaas:field_setup_write: The write access for field setups

  • cidaas:field_setup_delete: delete access for field setups