Skip to main content
GET
cURL

Query Parameters

hostname
string

Hostname.

endpoint_name
string
required

A name for the saml Endpoint.

metadata
string

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

metadata_type
enum<string>

Describes file/Text input of metadata.

Available options:
Text,
URL
entityID
enum<string>

EntityID type for SAML.

Available options:
Custom,
Hostname
custom_entityID
string

Custom entity ID.

extract_cert_from
string

Whether to extract cert metadata/response.

msgtemplatetype
enum<string>

Whether to use custom msg template.

Available options:
Custom,
Default
block_empty_profiles
boolean

Block empty profiles.

msgtemplate
string

Custom msgtemplate.

sign_authn_requests
boolean

Whether to sign Authn requests.

controller_login
boolean

Parameter to specify controller login.

rbac_groups
string

RBAC groups for controller login.

access_ctrl
enum<string>

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

Available options:
controller,
profile_attribute
username
string

Username for ctrl login authentication.

password
string

Password for ctrl login authentication.

login_ip
string

Remote IP of the user for ctrl login auth.

action
string

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

CID
string

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

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