Waiting for engine...
Skip to main content

AuthSourceJWT

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

type AuthSourceJWT implements AuthSource {
  id: ID!
  name: String!
  description: String
  roles: [AuthSourceRole!]
  issuer: String
  jwksUrl: String
  groupsAttribute: String
  audiences: [String!]
  issuerError: IssuerError
  userIdClaim: String!
}

Fields​

AuthSourceJWT.id ● ID! non-null scalar miscellaneous

The authentication source ID.

AuthSourceJWT.name ● String! non-null scalar miscellaneous

The name of the authentication source.

AuthSourceJWT.description ● String scalar miscellaneous

The description of the authentication source.

AuthSourceJWT.roles ● [AuthSourceRole!] list object platform

The roles associated with the authentication source.

AuthSourceJWT.issuer ● String scalar miscellaneous

The URL of the IDP that issues JWT.

AuthSourceJWT.jwksUrl ● String scalar miscellaneous

The JWK URI that holds the keys to verify JWT.

AuthSourceJWT.groupsAttribute ● String scalar miscellaneous

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

AuthSourceJWT.audiences ● [String!] list scalar miscellaneous

The list of the intended audience of a JWT.

AuthSourceJWT.issuerError ● IssuerError object platform

The error, if any, received while testing IDP.

AuthSourceJWT.userIdClaim ● String! non-null scalar miscellaneous

The claim within the JWT that should be used to retrieve the user ID. If the specified claim cannot be located in the JWT, the "sub" claim will be used instead.

Interfaces​

AuthSource interface platform​

An interface for authentication source

Returned By​

authSourceJWTCreate mutation ●  authSourceJWTUpdate mutation

On this Page