Version: 1.0

Field Settings API

Field Setup API

Field Setup defines the custom and system fields stored on a user profile: data types, validation rules, translations, OIDC scopes, and display order. Apps can mark fields as required or optional so registration and progressive profiling UIs can render the right set.

Authentication

Surface	Auth
Admin field setup (/fieldsetup-srv/fields…, graph search, order)	Bearer token with cidaas:field_setup_read, cidaas:field_setup_write, or cidaas:field_setup_delete (and matching admin roles)
Public registration fields (GET /user-srv/public/fields)	No access token. Requires a valid requestId from the authorization request

Public registration fields

Hosted registration and progressive profiling UIs should call GET /user-srv/public/fields?requestId=…. That endpoint is served by user-srv.

GET /fieldsetup-srv/public/fields remains available as a deprecated alias (also served by user-srv) and will be removed in a future release. Prefer the user-srv path for new integrations.

Authentication

OAuth 2.0: oauth2

Security Scheme Type:	oauth2
OAuth Flow (authorizationCode):	Token URL: https://domain/token-srv/token Authorization URL: https://domain/authz-srv/authz Refresh URL: https://domain/token-srv/token 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):	Token URL: https://domain/token-srv/token 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

Contact

cidaas support: [email protected]

URL: https://support.cidaas.com

Terms of Service

https://www.cidaas.com/terms-of-use/