Waiting for engine...
Skip to main content

AuthSourceSAML

A SAML authentication source that can be used to secure APIs or Developer Portals.

type AuthSourceSAML implements AuthSource {
  id: ID!
  name: String!
  description: String
  brokerId: String
  redirectUris: [String!]
  alias: String
  singleSignOnServiceUrl: String
  singleLogoutServiceUrl: String
  nameIdPolicyFormat: AuthSourceSAMLNameIdPolicyFormat
  httpPostBindingResponse: Boolean
  httpPostBindingRequest: Boolean
  signAuthenticationRequests: Boolean
  forceAuthentication: Boolean
  groupsAttribute: String
  roles: [AuthSourceRole!]
}

Fields​

AuthSourceSAML.id ● ID! non-null scalar miscellaneous {#id}

The authentication source ID.

AuthSourceSAML.name ● String! non-null scalar miscellaneous {#name}

The name of the authentication source.

AuthSourceSAML.description ● String scalar miscellaneous {#description}

The description of the authentication source.

AuthSourceSAML.brokerId ● String scalar miscellaneous {#broker-id}

ID of the Broker that the authentication source is attached to.

AuthSourceSAML.redirectUris ● [String!] list scalar miscellaneous {#redirect-uris}

The redirect URIs configured in the IDP.

AuthSourceSAML.alias ● String scalar miscellaneous {#alias}

The alias that will be sent in the token URL to identify the issuer.

AuthSourceSAML.singleSignOnServiceUrl ● String scalar miscellaneous {#single-sign-on-service-url}

The service URL of the IDP.

AuthSourceSAML.singleLogoutServiceUrl ● String scalar miscellaneous {#single-logout-service-url}

The logout URL configured in the IDP.

AuthSourceSAML.nameIdPolicyFormat ● AuthSourceSAMLNameIdPolicyFormat enum platform {#name-id-policy-format}

The name identifier formats supported by the IDP.

AuthSourceSAML.httpPostBindingResponse ● Boolean scalar miscellaneous {#http-post-binding-response}

Indicates whether to use Redirect Binding for responses sent to the identity provider.

AuthSourceSAML.httpPostBindingRequest ● Boolean scalar miscellaneous {#http-post-binding-request}

Indicates whether to use Redirect Binding when requesting information from the identity provider.

AuthSourceSAML.signAuthenticationRequests ● Boolean scalar miscellaneous {#sign-authentication-requests}

Indicates whether to sign requests sent to the identity provider.

AuthSourceSAML.forceAuthentication ● Boolean scalar miscellaneous {#force-authentication}

Indicates whether to force users to enter their credentials for the IDP even if they are logged in.

AuthSourceSAML.groupsAttribute ● String scalar miscellaneous {#groups-attribute}

The attribute name in the token that holds a list of groups to which the user belongs.

AuthSourceSAML.roles ● [AuthSourceRole!] list object platform {#roles}

The roles associated with the authentication source.

Interfaces​

AuthSource interface platform​

An interface for authentication source

On this Page