Skip to main content
POST
cURL

Body

application/json
endpoint_name
string
required

A name for the saml Endpoint.

idp_metadata
string
required

A SAML IDP Metadata URL/Text that is required if SAML is enabled on the gateway.

CID
string

The opaque session ID token. Required for 7.2 controllers only.

access_ctrl
enum<string>

Whether the access level is set by controller or a profile attribute.

Available options:
controller,
profile_attribute
action
string

The API action to perform. Required for 7.2 controllers only.

block_empty_profiles
boolean

Block empty profiles.

controller_login
boolean

Parameter to specify controller login.

entity_id
string

Custom entity ID.

entityid_type
enum<string>

EntityID type for SAML.

Available options:
Custom,
Hostname
groups
string

RBAC groups for controller login.

hostname
string

Hostname.

idp_metadata_type
enum<string>

Describes file/Text input of metadata.

Available options:
Text,
URL
login_ip
string

Remote IP of the user for ctrl login auth.

msgtemplate
string

Custom msgtemplate.

msgtemplatetype
enum<string>

Whether to use custom msg template.

Available options:
Custom,
Default
password
string

Password for ctrl login authentication.

sign_authn_requests
boolean

Whether to sign Authn requests.

username
string

Username for ctrl login authentication.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype
string

Error type if the API failed.

reason
string

Failure reason if the API failed.

results

API response data

return
boolean

Whether the API returned successfully