Get SAML AuthenticationOption

GET

/authentication-option-saml/{object_id}

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (AuthenticationOptionSaml)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

AuthenticationOptionSaml

Example:

AuthenticationOptionSaml

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "AuthenticationOptionSaml",
        "attributes": {
            "name": "string",
            "label": "string",
            "isActive": true,
            "preventRegistration": true,
            "authProviderId": "string",
            "type": "saml",
            "idpLoginUrl": "string",
            "metadataUrl": "string",
            "spEntityId": "string",
            "attributeFirstName": "string",
            "attributeLastName": "string",
            "attributeEmail": "string",
            "attributeSubPortalId": "string"
        },
        "relationships": {}
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Modified at 2025-07-08 10:51:21

Create SAML AuthenticationOption

Update SAML AuthenticationOption