> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pads4.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NDS.Services.Authentication.Integration

## Overview

Handles integration with external identity systems: SAML 2.0 login flows, circuit breaker diagnostics for identity provider connectivity, and message queue management for auth events.

| Field           | Value                                                                                       |
| --------------- | ------------------------------------------------------------------------------------------- |
| Swagger UI      | `https://<your-server>/rdx/NDS.Services.Authentication.Integration/swagger/index.html`      |
| OpenAPI spec    | `https://<your-server>/rdx/NDS.Services.Authentication.Integration/swagger/v1/swagger.json` |
| Base URL        | `https://<your-server>/rdx/NDS.Services.Authentication.Integration`                         |
| Total endpoints | 16                                                                                          |

***

## Authentication

All endpoints use the standard PADS4 session cookie. Obtain it once and reuse:

```bash theme={null}
# Log in and save the session cookie
curl -c cookies.txt -X POST 'https://<your-server>/api/v1/Account/Logon' \
  -H 'Content-Type: application/json' \
  -d '{"UserName": "admin", "Password": "yourpassword", "Domain": "yourdomain"}'

# Use the cookie on all subsequent requests
curl -b cookies.txt -X GET 'https://<your-server>/rdx/<ServiceName>/...'
```

> Replace `https://<your-server>` with your PADS4 server address and `<ServiceName>` with the service path shown above.

***

## Endpoint Reference

| Method | Path                                               | Description             |
| ------ | -------------------------------------------------- | ----------------------- |
| `GET`  | `/api/v1/{domain}/saml2/Login/{providerId}`        | Saml2 Login             |
| `GET`  | `/api/v1/{domain}/saml2/Authenticate/{providerId}` | Saml2 Authenticate      |
| `GET`  | `/api/v1/diagnostics/toggles`                      | Get Toggles             |
| `GET`  | `/api/v1/diagnostics/configuration`                | Get Config Section      |
| `GET`  | `/api/v1/diagnostics/configurationex`              | Get Configuration       |
| `GET`  | `/api/v1/diagnostics/circuitbreakers`              | Get Circuit Breakers    |
| `GET`  | `/api/v1/diagnostics/circuitbreakers/reset`        | Reset Circuit Breaker   |
| `GET`  | `/api/v1/diagnostics/circuitbreakers/isolate`      | Isolate Circuit Breaker |
| `POST` | `/api/v1/diagnostics/events`                       | Get Events              |
| `GET`  | `/api/v1/health`                                   | Get                     |
| `GET`  | `/api/v1/health/clean`                             | Get Clean               |
| `POST` | `/api/v1/Management/RequeueErrorMessages`          | Requeue Error Messages  |
| `POST` | `/api/v1/Management/PurgeErrorMessages`            | Purge Error Messages    |
| `GET`  | `/migration`                                       | Get Migrations          |
| `POST` | `/migration`                                       | Execute Migration       |
| `GET`  | `/version`                                         | Get                     |

***

## Request & Response Examples

### GET `/api/v1/{domain}/saml2/Login/{providerId}`

**Request:**

```bash theme={null}
curl -b cookies.txt -X GET 'https://<your-server>/rdx/NDS.Services.Authentication.Integration/api/v1/{domain}/saml2/Login/{providerId}'
```

**Response `200 OK`:**

```json theme={null}
{"Id": 1, "Name": "Example Item", "IsActive": true, "Code": "OK", "Succeeded": true}
```

***

### GET `/api/v1/{domain}/saml2/Authenticate/{providerId}`

**Request:**

```bash theme={null}
curl -b cookies.txt -X GET 'https://<your-server>/rdx/NDS.Services.Authentication.Integration/api/v1/{domain}/saml2/Authenticate/{providerId}'
```

**Response `200 OK`:**

```json theme={null}
{"Id": 1, "Name": "Example Item", "IsActive": true, "Code": "OK", "Succeeded": true}
```

***