Waiting for engine...
Skip to main content

AuthSourceOpenID

An OpenID authentication source that can be used to secure APIs or Developer Portals.

type AuthSourceOpenID implements AuthSource {
  id: ID!
  name: String!
  description: String
  brokerId: String
  redirectUris: [String!]
  alias: String
  standardFlowEnabled: Boolean
  implicitFlowEnabled: Boolean
  authUrl: String
  tokenUrl: String
  logoutUrl: String
  userInfoUrl: String
  clientId: String
  clientSecret: String
  issuer: String
  defaultScopes: String
  promptType: String
  groupsAttribute: String
  roles: [AuthSourceRole!]
}

Fields​

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

The authentication source ID.

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

The name of the authentication source.

AuthSourceOpenID.description ● String scalar miscellaneous {#description}

The description of the authentication source.

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

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

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

The redirect URIs configured in the IDP.

AuthSourceOpenID.alias ● String scalar miscellaneous {#alias}

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

AuthSourceOpenID.standardFlowEnabled ● Boolean scalar miscellaneous {#standard-flow-enabled}

Indicates whether Authorization Code Flow is enabled.

AuthSourceOpenID.implicitFlowEnabled ● Boolean scalar miscellaneous {#implicit-flow-enabled}

Indicates whether Implicit Flow is enabled.

AuthSourceOpenID.authUrl ● String scalar miscellaneous {#auth-url}

The authentication URL of the IDP.

AuthSourceOpenID.tokenUrl ● String scalar miscellaneous {#token-url}

The token URL of the IDP.

AuthSourceOpenID.logoutUrl ● String scalar miscellaneous {#logout-url}

The logout URL configured in the IDP.

AuthSourceOpenID.userInfoUrl ● String scalar miscellaneous {#user-info-url}

The user info URL configured in the IDP.

AuthSourceOpenID.clientId ● String scalar miscellaneous {#client-id}

The client ID configured in the IDP.

AuthSourceOpenID.clientSecret ● String scalar miscellaneous {#client-secret}

The client secret that is configured in the IDP.

AuthSourceOpenID.issuer ● String scalar miscellaneous {#issuer}

The issuer URL.

AuthSourceOpenID.defaultScopes ● String scalar miscellaneous {#default-scopes}

The scopes to be included in token request.

AuthSourceOpenID.promptType ● String scalar miscellaneous {#prompt-type}

The login prompt types for renewing access tokens.

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

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

AuthSourceOpenID.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