Authentication Server (admin user)

8 min

The auth-servers entity represents a nSA authentication server. Authentication servers support the following activities:

Retrieving All Authentication Servers, see Retrieving All Authentication Servers.

Creating a Local Authentication Server, see Creating a Local Authentication Server.

Creating a SAML Authentication Server, see Creating a SAML Authentication Server.

Retrieving All Authentication Servers

To retrieve all auth-servers entities, use the REST API call below:

Method: GET /api/v1/policies/auth-servers

Resource: Path

JSON Data: No JSON is required for this request.

If processed correctly, a JSON body containing a list of all auth-servers is returned. Otherwise, a JSON body containing an error is returned.

Request

This REST API command always retrieves all auth-servers entities.

The following is an example request:

GET /api/v1/policies/auth-servers
                Authorization:
            Content-Type: application/json

Response

The following is an example response:

HTTP/1.1 200 OK
                Content-Type: application/json
                Response Body
                {
                "total": 0,
                "auth_servers": [
                {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "Local",
                "name": "string"
                },
                {
                "id": "2c963f64-5717-4562-b3fc-2c963f66afa6",
                "type": "Local",
                "name": "string"
                },
                {
                "id": "66afa664-5717-4562-b3fc-2c963f66afa6",
                "type": "Local",
                "name": "string"
                },
                {
                "id": "63f66a64-5717-4562-b3fc-2c963f66afa6",
                "type": "Local",
                "name": "string"
                }
                ]
            }

Creating a Local Authentication Server

To create a local authentication server:

Method: POST /api/v1/policies/auth-servers

Resource: Path

JSON Data: JSON dictionary representing a new local auth-servers entity.

If processed correctly, a JSON body containing the new local auth-servers entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/auth-servers
                Authorization:
                Request Body
                {
                "type": "Local",
                "name": "string",
                "cert_config": {
                "user_name_template": "string"
                },
                "local_config": {
                "users": [
                {
                "name": "string",
                "full_name": "string",
                "password": "string",
                "password_change_required": true
                }
                ]
                },
                "samlsp_config": {
                "metadata_config_type": "url",
                "metadata_config_url": "string",
                "idp_type": "Azure AD",
                "idp_metadata_xml": "string"
                }
            }

Response

The following is an example response:

HTTP/1.1 200 OK
                Content-Type: application/json
                Response Body
                {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "Local",
                "name": "string",
                "cert_config": {
                "user_name_template": "string"
                },
                "samlsp_config": {
                "metadata_config_type": "url",
                "metadata_config_url": "string",
                "idp_type": "Azure AD",
                "idp_metadata_xml": "string"
                }
            }

Creating a SAML Authentication Server

To create a remote SAML authentication server:

Method: POST /api/v1/policies/auth-servers

Resource: Path

JSON Data: JSON dictionary representing a new SAML auth-servers entity.

If processed correctly, a JSON body containing the new SAML auth-servers entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/auth-servers
                Authorization:
                Request Body
                {
                "type": "SAML (Azure AD)",
                "name": "auth_server_1",
                "samlsp_config": {
                "idp_metadata_xml": "string"
                "idp_type": "Azure AD",
                "metadata_config_type": "file",
                "metadata_config_url": "string",
                }
            }

Response

The following is an example response:

HTTP/1.1 200 OK
                Content-Type: application/json
                Response Body
                {
                "id": "ab45c43278b42312f00fab4321af54c0543b",
                "type": "SAML (Azure AD)",
                "name": "auth_server_1",
                "samlsp_config": {
                "idp_metadata_xml": "string"
                "idp_type": "Azure AD",
                "metadata_config_type": "file",
                "metadata_config_url": "string",
                }
            }