Skip to main content

OidcClient

Represents an OIDC client.

type OidcClient {
  allowAnyPartner: Boolean!
  applicationType: OidcApplicationType!
  backgroundColor: String
  backgroundImage: URL
  claimMappings: [OidcClaimMapping!]!
  clientType: OidcClientType!
  createdAt: DateTime!
  createdBy: User!
  credentialTypes: [String!]
  deletedAt: DateTime
  id: ID!
  logo: URL
  name: String!
  partners: [Partner!]!
  policyUrl: URL
  postLogoutUris: [URL!]!
  presentations(
    limit: PositiveInt = 100
    offset: PositiveInt
    where: OidcClientPresentationWhere
  ): [Presentation!]!
  redirectUris: [URL!]!
  requireFaceCheck: Boolean!
  resources: [OidcClientResource!]
  termsOfServiceUrl: URL
  uniqueClaimsForSubjectId: [String!]
  updatedAt: DateTime
  updatedBy: User
}

Fields​

OidcClient.allowAnyPartner ● Boolean! non-null scalar​

Indicates whether the client allows presentations of credentials from any configured partner.

OidcClient.applicationType ● OidcApplicationType! non-null enum​

The type of OIDC application.

OidcClient.backgroundColor ● String scalar​

The background color, to be displayed during auth interactions, in hexadecimal format.

OidcClient.backgroundImage ● URL scalar​

The URL of the background image to be displayed during auth interactions, can be an image encoded as a data URL.

OidcClient.claimMappings ● [OidcClaimMapping!]! non-null object​

The claim mappings to be applied to this client.

OidcClient.clientType ● OidcClientType! non-null enum​

The type of OIDC client.

OidcClient.createdAt ● DateTime! non-null scalar​

When the client was created.

OidcClient.createdBy ● User! non-null object​

The user who created the client.

OidcClient.credentialTypes ● [String!] list scalar​

The types of credentials that can be presented for authentication with this client.

Note:

  • If not specified, any credential type can be presented.
  • The client can specify the credential type to use for authentication via the vc_type auth request parameter.
  • If values are defined here and the vc_type auth request parameter is provided, it is validated to be from this list.

OidcClient.deletedAt ● DateTime scalar​

When the client was deleted.

OidcClient.id ● ID! non-null scalar​

OidcClient.logo ● URL scalar​

The URL of the client logo to be displayed during auth interactions, can be an image encoded as a data URL.

OidcClient.name ● String! non-null scalar​

The name of the client.

OidcClient.partners ● [Partner!]! non-null object​

The partners that the client allows presentations of credentials from.

OidcClient.policyUrl ● URL scalar​

The URL of a privacy policy for the client, displayed during auth interactions.

OidcClient.postLogoutUris ● [URL!]! non-null scalar​

The post-logout URIs that the client is allowed to use.

OidcClient.presentations ● [Presentation!]! non-null object​

Returns the successful credential presentations that were requested for authorization .

OidcClient.presentations.limit ● PositiveInt scalar​
OidcClient.presentations.offset ● PositiveInt scalar​
OidcClient.presentations.where ● OidcClientPresentationWhere input​

OidcClient.redirectUris ● [URL!]! non-null scalar​

The redirect URIs that the client is allowed to use.

OidcClient.requireFaceCheck ● Boolean! non-null scalar​

Indicates this client must use face check with every authentication presentation.

OidcClient.resources ● [OidcClientResource!] list object​

The resources that the client has access to, according to the defined resource scopes.

OidcClient.termsOfServiceUrl ● URL scalar​

The URL of the terms of service for the client, displayed during auth interactions.

OidcClient.uniqueClaimsForSubjectId ● [String!] list scalar​

The unique claim(s) which can be used to derive the subject identifier (sub claim value) from partner credentials (where no unique claim value is known).

Note:

  • This is not needed for authentication using Verified Orchestration credentials, the issuanceId claim is used.
  • The authentication client also can specify the claim to use via the vc_unique_claim_for_sub auth request parameter.
  • Multiple values can be specified here, if not specified via the client vc_unique_claim_for_sub auth request parameter, the first claim that is present in the partner presentation will be used.
  • If values are defined here and the vc_unique_claim_for_sub auth request parameter is provided, it is validated to be from this list.

OidcClient.updatedAt ● DateTime scalar​

When the client was last updated.

OidcClient.updatedBy ● User object​

The user who last updated the client.

Returned By​

createOidcClient mutation ● createOidcClientResource mutation ● deleteOidcClient mutation ● deleteOidcClientResource mutation ● findOidcClients query ● oidcClient query ● updateOidcClient mutation ● updateOidcClientClaimMappings mutation ● updateOidcClientResource mutation

Member Of​

Presentation object