### Get Schedule Setups - Multiple Configurations Example

Source: https://docs.cidaas.com/openapi/3.102.5/user-scheduling/get-schedule-setups

This example demonstrates a successful response when multiple schedule setups are configured. It includes two distinct configurations: one for reminders and another for changing user status.

```json
{
  "success": true,
  "status": 200,
  "data": [
    {
      "id": "COMMUNICATION_VERIFICATION_MEDIUM_REMIND_VERIFICATION_1",
      "updatedTime": "2025-01-10T03:05:15.409Z",
      "createdTime": "2025-01-10T03:05:15.409Z",
      "enabled": true,
      "condition": "COMMUNICATION_VERIFICATION_MEDIUM",
      "action": "REMIND_VERIFICATION",
      "timeOffsetInSecs": 30,
      "periodic": false,
      "templateKey": "OPTIN_REMINDER",
      "reminderNo": 1,
      "retryRequired": false
    },
    {
      "id": "COMMUNICATION_VERIFICATION_MEDIUM_CHANGE_USERSTATUS_DECLINED",
      "createdTime": "2025-01-08T10:26:22.143Z",
      "updatedTime": "2025-01-08T10:27:25.848Z",
      "enabled": true,
      "condition": "COMMUNICATION_VERIFICATION_MEDIUM",
      "action": "CHANGE_USERSTATUS",
      "timeOffsetInSecs": 3600,
      "periodic": false,
      "targetUserStatus": "DECLINED",
      "retryRequired": true
    }
  ]
}
```

--------------------------------

### Get Schedule Setups - Single Configuration Example

Source: https://docs.cidaas.com/openapi/3.102.5/user-scheduling/get-schedule-setups

This example shows a successful response when one schedule setup is configured. It includes details like ID, timestamps, enabled status, condition, action, time offset, and template key.

```json
{
  "success": true,
  "status": 200,
  "data": [
    {
      "id": "COMMUNICATION_VERIFICATION_MEDIUM_REMIND_VERIFICATION_1",
      "createdTime": "2025-01-17T05:48:35.446227582Z",
      "updatedTime": "2025-01-17T05:48:35.446227582Z",
      "enabled": true,
      "condition": "COMMUNICATION_VERIFICATION_MEDIUM",
      "action": "REMIND_VERIFICATION",
      "timeOffsetInSecs": 3600,
      "periodic": false,
      "retryRequired": false,
      "templateKey": "OPTIN_REMINDER",
      "targetUserStatus": "DECLINED",
      "reminderNo": 1
    }
  ]
}
```

--------------------------------

### Get Field Setup Request in C#

Source: https://docs.cidaas.com/openapi/fieldSettings/get-field-setup

Example of making a GET request to retrieve field setup information using HttpClient in C#. Ensure you replace `<token>` with a valid access token.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://demo.cidaas.de/fieldsetup-srv/fields/:fieldKey");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### Create or Update Schedule Setup - Delete Setup Example

Source: https://docs.cidaas.com/openapi/3.102.5/user-scheduling/create-or-update-schedule-setup

This example demonstrates how to configure a schedule setup for deleting a resource. It specifies the condition, action, and time offset.

```json
{
  "condition": "COMMUNICATION_VERIFICATION_MEDIUM",
  "action": "DELETE",
  "timeOffsetInSecs": 86400,
  "periodic": false,
  "enabled": true,
  "retryRequired": false
}
```

--------------------------------

### Create or Update Schedule Setup - Reminder Setup Example

Source: https://docs.cidaas.com/openapi/3.102.5/user-scheduling/create-or-update-schedule-setup

This example shows how to set up a schedule for sending verification reminders. It includes the template key and retry configuration.

```json
{
  "condition": "COMMUNICATION_VERIFICATION_MEDIUM",
  "action": "REMIND_VERIFICATION",
  "timeOffsetInSecs": 1800,
  "periodic": false,
  "enabled": true,
  "templateKey": "OPTIN_REMINDER",
  "retryRequired": true
}
```

--------------------------------

### Retrieve Field Setup using HttpClient in C#

Source: https://docs.cidaas.com/openapi/3.102.5/fieldSettings/get-field-setup

Example of how to make a GET request to the field setup endpoint using HttpClient in C#. Ensure you have a valid Bearer token.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://demo.cidaas.de/fieldsetup-srv/fields/:fieldKey");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Create or Update Schedule Setup - Status Change Setup Example

Source: https://docs.cidaas.com/openapi/3.102.5/user-scheduling/create-or-update-schedule-setup

This example illustrates how to configure a schedule setup to change a user's status. It specifies the target user status and retry settings.

```json
{
  "condition": "COMMUNICATION_VERIFICATION_MEDIUM",
  "action": "CHANGE_USERSTATUS",
  "timeOffsetInSecs": 7200,
  "periodic": false,
  "enabled": true,
  "targetUserStatus": "DECLINED",
  "retryRequired": true
}
```

--------------------------------

### Complete Field Setup Example

Source: https://docs.cidaas.com/openapi/3.102.5/fieldSettings/store-field-setup

Provides a comprehensive example of a field setup object, illustrating all possible properties for a TEXT field, including localization, validation rules, and metadata.

```json
{

  "fieldKey": "employee_id",  

  "dataType": "TEXT",  

  "order": 0,  

  "localeTexts": [  

    {

      "locale": "en-US",  

      "name": "Customer No.",  

      "minLength": "6",  

      "maxLength": "8",  

      "required": "customer no. is required",  

      "consentLabel": {

        "label": "<a href=\"{{d1456cbe-2c4d-4ede-a766-cad3b97ea3bc}}\">your-label</a>",  

        "label_text": "<a href=\"{{d1456cbe-2c4d-4ede-a766-cad3b97ea3bc}}\">your-label-text</a>"

      },

      "attributes": {

        "key": "customerId",  

        "value": "C-113323"  

      }

    }

  ],

  "fieldDefinition": {

    "locale": "string",  

    "name": "string",  

    "regex": "string"

  },

  "readOnly": true,  

  "enabled": true,  

  "required": true,  

  "internal": true,  

  "scopes": [

    "string"

  ],

  "parent_group_id": "string",  

  "fieldType": "SYSTEM",  

  "baseDataType": "string",  

  "defaultValue": "string",  

  "claimable": true,  

  "isSearchable": true,  

  "overwriteWithNullValueFromSocialProvider": true,  

  "unique": true  

}

```

--------------------------------

### C# HttpClient Example

Source: https://docs.cidaas.com/openapi/3.102.5/notifications/get-service-setup-by-tenant

This C# code snippet demonstrates how to make a GET request to the service setups endpoint using HttpClient.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://demo.cidaas.de/notifications-srv/servicesetups");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Example Enrollment Flow

Source: https://docs.cidaas.com/integration/instance-setup-migration

This illustrates a typical user enrollment flow for verification methods, starting from registration through email verification, first login, MFA setup, and optional backup code generation.

```text
Registration → Email Verification → 
First Login → MFA Setup Prompt → 
TOTP Setup → Backup Codes Generation → 
Complete
```

--------------------------------

### C# HttpClient Example

Source: https://docs.cidaas.com/openapi/3.102.5/user-scheduling/get-schedule-setups

Demonstrates how to use HttpClient in C# to make a GET request to the user-scheduling-srv endpoint to retrieve schedule setups. Ensure you replace '<token>' with a valid access token.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://demo.cidaas.de/user-scheduling-srv/schedules");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### Request Body Example

Source: https://docs.cidaas.com/openapi/3.102.5/public-service/post-verification-srv-public-graph-user-setup

Example of the JSON payload required for the verification setup request.

```json
{
  "request_id": "bf82d8b9-77b9-4352-8611-2775a09ccfe9",
  "identifier": "test-user@widas.de"
}
```

--------------------------------

### Get Webhook Setup by ID - Request Example

Source: https://docs.cidaas.com/openapi/3.102.5/webhooks/get-webhook-setup-by-id

This snippet shows the HTTP method and URL for retrieving a webhook setup by its ID.

```http
GET
## https://demo.cidaas.de/webhook-srv/webhooks/:id
```

--------------------------------

### Get specific field setups by IDs

Source: https://docs.cidaas.com/openapi/3.102.5/fieldSettings/graph-find-field-setups

Retrieve specific field setups by providing an array of their IDs. This example shows how to fetch 'email', 'given_name', and 'department' field setups.

```json
{
  "from": 0,
  "size": 50,
  "object_ids": [
    "email",
    "given_name",
    "department"
  ]
}
```

--------------------------------

### Get Schedule Setup by ID using C# HttpClient

Source: https://docs.cidaas.com/openapi/user-scheduling/get-schedule-setup-by-id

Example of how to retrieve a schedule setup by its ID using C# HttpClient. Ensure you have a valid OAuth2 bearer token for authorization.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://demo.cidaas.de/user-scheduling-srv/schedules/:id");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Create User Schedules - Combined (Global and User-Specific)

Source: https://docs.cidaas.com/openapi/3.102.5/user-scheduling/create-user-schedules

Use this example to apply global setups and simultaneously add user-specific schedules. This allows for a combination of automated and custom scheduling.

```json
{
  "sub": "user-12345",
  "requestId": "req-67890",
  "scheduleSpecificSchedulesOnly": false,
  "specificSchedules": [
    {
      "action": "SCHEDULE_DELETION",
      "condition": "NONE",
      "timeOffsetInSecs": 86400,
      "periodic": false
    }
  ]
}
```

--------------------------------

### Initiate Verification Setup Method (C#)

Source: https://docs.cidaas.com/openapi/3.102.5/verification/postverification-actions-srv-setup-method-initiation

This C# code snippet demonstrates how to send a POST request to initiate a verification setup method. Ensure you have a valid OAuth2 token and replace placeholders for method and trackId.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "https://demo.cidaas.de/verification-actions-srv/setup/:method/initiation/:trackId");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### Initiate Verification Setup Method

Source: https://docs.cidaas.com/openapi/verification/postverification-actions-srv-setup-method-initiation

Initiates the verification setup process. Requires the verification method and a track ID to be specified in the path. An empty JSON object is expected as the request body.

```APIDOC
## POST /verification-actions-srv/setup/:method/initiation/:trackId

### Description
Initiates the verification setup process for a given method and track ID.

### Method
POST

### Endpoint
/verification-actions-srv/setup/:method/initiation/:trackId

### Parameters
#### Path Parameters
- **method** (string) - Required - The verification method to initiate.
- **trackId** (string) - Required - The unique identifier for tracking the initiation process.

#### Request Body
- **{}** (object) - Required - An empty JSON object.

### Request Example
```json
{
  "example": "{}"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the response data from the initiation process.
- **status** (number) - The HTTP status code of the response.
- **time** (string) - The timestamp of the response.

#### Response Example
```json
{
  "data": {
    "sub": "string",
    "email": "string",
    "gender": "string",
    "givenName": "string",
    "locale": "string",
    "middleName": "string",
    "name": "string",
    "nickname": "string",
    "phone": "string",
    "picture": "string",
    "preferredUsername": "string",
    "profile": "string",
    "provider": "string",
    "updated": "string",
    "website": "string",
    "zoneinfo": "string",
    "birthdate": "string",
    "family_name": "string",
    "formatted": "string",
    "street_address": "string",
    "locality": "string",
    "region": "string",
    "postal_code": "string",
    "country": "string",
    "username": "string",
    "last_login": "string",
    "created": "string",
    "last_updated": "string",
    "email_verified": "boolean",
    "phone_verified": "boolean",
    "identity_id": "string",
    "tenant_id": "string",
    "user_id": "string",
    "provider_id": "string",
    "provider_user_id": "string",
    "additional_info": {},
    "group": "string",
    "roles": [
      "string"
    ],
    "custom_data": {},
    "status_id": "string",
    "status": "string",
    "last_login_date": "string",
    "last_updated_date": "string",
    "created_date": "string",
    "email_verified_date": "string",
    "phone_verified_date": "string"
  },
  "status": 200,
  "time": "2023-09-19T12:00:00Z"
}
```
```

--------------------------------

### Create Schedule Setup using C# HttpClient

Source: https://docs.cidaas.com/openapi/3.102.5/user-scheduling/create-or-update-schedule-setup

Example of creating a schedule setup using C# HttpClient. Ensure the Authorization header is correctly set with a Bearer token.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "https://demo.cidaas.de/user-scheduling-srv/schedules");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{\n  \"condition\": \"COMMUNICATION_VERIFICATION_MEDIUM\",\n  \"timeOffsetInSecs\": 3600,\n  \"periodic\": false,\n  \"enabled\": true,\n  \"retryRequired\": false,\n  \"templateKey\": \"OPTIN_REMINDER\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### Create Field Setup using HttpClient (C#)

Source: https://docs.cidaas.com/openapi/3.102.5/fieldSettings/store-field-setup

Example of creating a new field setup using HttpClient in C#. Ensure the Authorization header is correctly set with a valid Bearer token.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "https://demo.cidaas.de/fieldsetup-srv/fields");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var content = new StringContent("{
  \"fieldKey\": \"employee_id\",
  \"dataType\": \"TEXT\",
  \"order\": 0,
  \"localeTexts\": [
    {
      \"locale\": \"en-US\",
      \"name\": \"Customer No.\",
      \"minLength\": \"6\",
      \"maxLength\": \"8\",
      \"required\": \"customer no. is required\",
      \"consentLabel\": {
        \"label\": \"<a href=\\\"{{d1456cbe-2c4d-4ede-a766-cad3b97ea3bc}}\\\">your-label</a>\",
        \"label_text\": \"<a href=\\\"{{d1456cbe-2c4d-4ede-a766-cad3b97ea3bc}}\\\">your-label-text</a>\"
      },
      \"attributes\": {
        \"key\": \"customerId\",
        \"value\": \"C-113323\"
      }
    }
  ],
  \"fieldDefinition\": {
    \"locale\": \"string\",
    \"name\": \"string\",
    \"regex\": \"string\"
  },
  \"readOnly\": true,
  \"enabled\": true,
  \"required\": true,
  \"internal\": true,
  \"scopes\": [
    \"string\"
  ],
  \"parent_group_id\": \"string\",
  \"fieldType\": \"SYSTEM\",
  \"baseDataType\": \"string\",
  \"defaultValue\": \"string\",
  \"claimable\": true,
  \"isSearchable\": true,
  \"overwriteWithNullValueFromSocialProvider\": true,
  \"unique\": true
}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### Get Scope by ScopeKey Request Example

Source: https://docs.cidaas.com/openapi/3.102.5/app-settings/get-scope-by-scope-key

This snippet shows an example of a successful GET request to retrieve a scope by its scopeKey.

```http
GET 
## https://demo.cidaas.de/scopes-srv/scope
```

--------------------------------

### Successful Role Setup Response

Source: https://docs.cidaas.com/openapi/3.102.5/groupNroles/get-role-setup

Example of a successful response when retrieving role setup information. Includes role details, owner, description, and timestamps.

```json
{
  "status": 200,
  "success": true,
  "data": {
    "role": "PROJECT_MANAGER",
    "roleOwner": "client",
    "description": "Project manager role with access to project resources",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z"
  }
}
```

--------------------------------

### Logout with access_token_hint Example

Source: https://docs.cidaas.com/openapi/authentication/get-end-session

Example of a GET request using access_token_hint to identify the session. Note that id_token_hint is recommended for GET requests.

```http
GET https://demo.cidaas.de/session/end_session?access_token_hint=eyJhbGciOiJSUzI1NiIsImtpZCI6IjdlNzdiZjlkLTUwZmYtNDBkYi04NDdhLWVmZTNiNDc2YzY1NCJ9...
```

--------------------------------

### Initiate Verification Setup

Source: https://docs.cidaas.com/openapi/3.102.5/verification/post-verification-srv-v-2-setup-initiate-verification-type

Initiates the verification process for a specified method. Requires device information and an authorization token.

```APIDOC
## POST /verification-actions-srv/setup/:method/initiation

### Description
Initiates the verification process for a specified method. Requires device information and an authorization token.

### Method
POST

### Endpoint
/verification-actions-srv/setup/:method/initiation

### Parameters
#### Path Parameters
- **method** (string) - Required - The verification method to use. Supported values: fido2, push, email, sms, totp, pattern, backupCode, password, voice, face, fidou, u2f, security_question

#### Header Parameters
- **Accept** (string) - Optional - `application/json`
- **Authorization** (string) - Required - Bearer token for authentication.

#### Request Body
- **deviceInfo** (object) - Required - Information about the device.
  - **deviceId** (string) - Required - The unique identifier for the device.
  - **location** (object) - Optional - Geographic location of the device.
    - **lat** (string) - Optional - Latitude coordinate.
    - **lon** (string) - Optional - Longitude coordinate.

### Request Example
```json
{
  "deviceInfo": {
    "deviceId": "7a5a4557-ef84-4262-a9d6",
    "location": {
      "lat": "37.7749° N",
      "lon": "122.4194° W"
    }
  }
}
```

### Response
#### Success Response (200)
- The response body will contain details of the initiated verification process. (Specific schema not provided in source)
```

--------------------------------

### C# HttpClient Example

Source: https://docs.cidaas.com/openapi/3.102.5/consent-management/get-consent-info-lite

Example of how to use HttpClient in C# to make a GET request to the Get Consent Info Lite API.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://demo.cidaas.de/consent-srv/consent/lite/:id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Service Setups by Tenant API Endpoint

Source: https://docs.cidaas.com/openapi/3.102.5/notifications/get-service-setup-by-tenant

This is the GET endpoint to retrieve service setups for tenants. It is available from cidaas version 3.101.2.

```http
GET
## https://demo.cidaas.de/notifications-srv/servicesetups
```

--------------------------------

### POST /verification-actions-srv/setup/:method/initiation

Source: https://docs.cidaas.com/openapi/3.102.5/verification/post-verification-srv-v-2-setup-initiate-verification-type

Initiates the verification enrollment for a selected method. This endpoint is used to start the setup process for verification types like fido, push, email, etc., by providing necessary device information.

```APIDOC
## POST /verification-actions-srv/setup/:method/initiation

### Description
This API call initiates verification enrollment for the selected `method` (e.g., fido, push).

### Method
POST

### Endpoint
`https://demo.cidaas.de/verification-actions-srv/setup/:method/initiation`

### Parameters
#### Path Parameters
- **method** (string) - Required - Type of verification the user has configured. Possible values: [`fido2`, `push`, `email`, `sms`, `totp`, `pattern`, `backupcode`, `password`, `voice`, `face`, `fidou2f`, `security_question`]. Example: `push`

#### Header Parameters
- **Content-Type** (string) - Required - `application/json`
- **Authorization** (string) - Required - `Bearer token`

#### Request Body
- **deviceInfo** (object) - Optional - Details of the device.
  - **deviceId** (string) - Optional - Id of the device. Example: `7a5a4557-ef84-4262-a9d6`
  - **location** (object) - Optional - Location details of the device.
    - **lat** (string) - Optional - latitude of the device. Example: `37.7749° N`
    - **lon** (string) - Optional - longitude of the device. Example: `122.4194° W`

### Request Example
```json
{
  "deviceInfo": {
    "deviceId": "7a5a4557-ef84-4262-a9d6",
    "location": {
      "lat": "37.7749° N",
      "lon": "122.4194° W"
    }
  }
}
```

### Responses
#### Success Response (200)
- **status** (number) - Https status code. Example: `200`
- **success** (boolean) - Indicates if the operation was successfully performed or if it failed. Default value: `true`
- **data** (object)
  - **exchange_id** (object)
    - **exchange_id** (string) - ID to be used to proceed further steps to configure physical verification setup. Example: `ebf282d8-b611-4d0e-8d02-f6d53e3bc3f3`
    - **expires_at** (string) - Expiry time for the code received. Example: `2023-04-30T21:42:55.175Z`
    - **_id** (string) - Identifier of the system. Example: `7a5a4557-ef84-4262-a9d6-856078e6f8d3`
    - **createdTime** (string) - Created time of the code. Example: `2023-04-30T21:32:55.181Z`
    - **updatedTime** (string) - Updated time of the code. Example: `2023-04-30T21:32:55.181Z`
    - **__ref** (string) - Reference ID of the system. Example: `1682890375085-432822fb-2311-46c3-a655-f8f010578d3d`
  - **authenticator_client_id** (string) - App client ID. Example: `b77de608-6646-4916-8fa9-839cc81157c2`
  - **sub** (string) - Cidaas user ID. Example: `c4f05b1a-d3a2-4642-877e-1e38c98b60c6`
  - **status_id** (string) - ID to check the latest status about MFA setup initiate request. Example: `7816a5e9-9e58-42ff-8a03-bbe24140c98f`

#### Success Response Example (200)
```json
{
  "status": 200,
  "success": true,
  "data": {
    "exchange_id": {
      "exchange_id": "ebf282d8-b611-4d0e-8d02-f6d53e3bc3f3",
      "expires_at": "2023-04-30T21:42:55.175Z",
      "_id": "7a5a4557-ef84-4262-a9d6-856078e6f8d3",
      "createdTime": "2023-04-30T21:32:55.181Z",
      "updatedTime": "2023-04-30T21:32:55.181Z",
      "__ref": "1682890375085-432822fb-2311-46c3-a655-f8f010578d3d"
    },
    "authenticator_client_id": "b77de608-6646-4916-8fa9-839cc81157c2",
    "sub": "c4f05b1a-d3a2-4642-877e-1e38c98b60c6",
    "status_id": "7816a5e9-9e58-42ff-8a03-bbe24140c98f"
  }
}
```

#### Error Response (400)
- **success** (boolean) - False if operation was unsuccessful. Default value: `false`
- **status** (number) - Https status code. Example: `400`
- **code** (string) - A specific error code representing the failure reason. Example: `01230`
- **error** (string) - Error message description. Example: `invalid_payload`

#### Error Response Example (400)
```json
{
  "success": false,
  "status": 400,
  "code": "01230",
  "error": "invalid_payload"
}
```

#### Error Response (409)
- **success** (boolean) - False if operation was unsuccessful. Default value: `false`
- **status** (number) - Https status code. Example: `400`
- **code** (string) - A specific error code representing the failure reason. Example: `01230`
- **error** (string) - Error message description. Example: `invalid_payload`

#### Error Response Example (409)
```json
{
  "success": false,
  "status": 400,
  "code": "01230",
  "error": "invalid_payload"
}
```
```

--------------------------------

### HTTP GET Request Example

Source: https://docs.cidaas.com/openapi/authentication/get-social-login-by-request-id

This example shows how to make a GET request to the social login endpoint. It requires the provider name and request ID in the URL.

```http
GET https://demo.cidaas.de/login-srv/social/login/:provider_name/:requestId
```

--------------------------------

### Webhook Setup Example (APIKEY Auth)

Source: https://docs.cidaas.com/openapi/3.102.5/webhooks/store-webhook-setup

This JSON body demonstrates the structure for a webhook setup using APIKEY authentication. The apikeyDetails object specifies how the API key should be transmitted.

```json
{
  "_id": "string",
  "url": "string",
  "events": [
    "ACCOUNT_CREATED_WITH_CIDAAS_IDENTITY",
    "ACCOUNT_CREATED_WITH_SOCIAL_IDENTITY",
    "ACCOUNT_MODIFIED",
    "ACCOUNT_DELETED"
  ],
  "auth_type": "APIKEY",
  "apikeyDetails": {
    "apikey": "string",
    "apikey_placeholder": "string",
    "apikey_placement": "header"
  },
  "disable": true,
  "createdTime": "2024-07-29T15:51:28.071Z",
  "updatedTime": "2024-07-29T15:51:28.071Z"
}
```

--------------------------------

### Get Role Setup using C# HttpClient

Source: https://docs.cidaas.com/openapi/3.102.5/groupNroles/get-role-setup

Demonstrates how to fetch role setup information using C#'s HttpClient. Ensure you have a valid Bearer token and replace the placeholder role ID.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://demo.cidaas.de/groups-srv/roles/:role");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Bearer <token>");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  

```

--------------------------------

### Minimal Regular Web App Client Configuration

Source: https://docs.cidaas.com/openapi/3.102.5/app-settings/store-client

This example demonstrates the configuration for a Regular Web Application. Key settings include redirect URIs, scopes, and grant types.

```json
{
  "client_type": "REGULAR_WEB",
  "client_name": "my-web-app",
  "client_display_name": "My Web Application",
  "redirect_uris": [
    "https://myapp.example.com/callback"
  ],
  "allowed_logout_urls": [
    "https://myapp.example.com"
  ],
  "allowed_scopes": [
    "openid",
    "profile",
    "email"
  ],
  "response_types": [
    "code"
  ],
  "grant_types": [
    "authorization_code",
    "refresh_token"
  ],
  "hosted_page_group": "default",
  "template_group_id": "default",
  "accentColor": "#ef4923",
  "primaryColor": "#f7941d",
  "company_name": "My Company",
  "company_address": "123 Main St",
  "company_website": "https://mycompany.com"
}
```

--------------------------------

### Get Field Setup

Source: https://docs.cidaas.com/openapi/3.102.5/fieldSettings/get-field-setup

Retrieves the field setup configuration for a given field key.

```APIDOC
## GET /fieldsetup-srv/fields/:fieldKey

### Description
This API call returns field setup for the given fieldKey.

### Method
GET

### Endpoint
https://demo.cidaas.de/fieldsetup-srv/fields/:fieldKey

### Parameters
#### Path Parameters
- **fieldKey** (string) - required - fieldKey is the unique identifier of fieldSetup
```

--------------------------------

### Field Setup API Response Example

Source: https://docs.cidaas.com/guides/authentication-authorisation/prechecks/password-change

This JSON object shows a sample response from the field setup API, detailing localized text for password fields, including names, validation messages, and constraints.

```json
{
  "success": true,
  "status": 200,
  "data": [
    ...
    {
      "_id": "da24c493-f0ea-4820-a046-d505058db828",
      "order": 4,
      "fieldKey": "password_echo",
      "dataType": "PASSWORD",
      ...
      "fieldDefinition": {
        "maxLength": 20,
        "matchWith": "password"
      },
      "localeText": {
        "locale": "en-us",
        "language": "en",
        "name": "Confirm Password",
        "maxLength": "Confirm Password cannot be more than 20 chars.",
        "required": "Please enter confirm password",
        "matchWith": "password must match with confirm password"
      }

    }
    ...
  ]
}

```