OIDC
@hyperledger/identus-sdk v8.0.0
@hyperledger/identus-sdk / plugins/internal/oidc
plugins/internal/oidc
This export contains the OIDC plugin for the Identus SDK Please use the following export
How to use
Typescript / esmodules
import * as OIDC from "@hyperledger/identus-sdk/plugins/oidc";
Or with cjs modules
const OIDC = require("@hyperledger/identus-sdk/plugins/oidc");
Namespaces
| Namespace | Description |
|---|---|
| Protocols | - |
Classes
| Class | Description |
|---|---|
| AuthorizationRequest | - |
| AuthorizationResponse | - |
| CreateAuthorizationRequest | manage the creation of an Authorization Request |
| CreateCredentialRequest | create a CredentialRequest for the given offer a connection with the relevant Issuer must have already been established |
| CredentialRequest | - |
| FetchAuthServerMeta | try to retrieve Authorization Server Metadata from the give URI /.well-known/openid-configuration will be appended to the URI |
| FetchIssuerMetadata | try to retrieve Issuer Metadata from the given URI /.well-known/openid-credential-issuer will be appended to the uri |
| OIDCConnection | Define the structure of a Connection |
| OIDCModule | https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html |
| ParseCredentialOffer | validates the offer is correctly formed OIDC Credential Offer returns the offer Typed as such |
| ProcessCallbackUrl | - |
| ResolveAuthorizationRequest | OIDC Convenience Task Credential Offer to Authorization Request |
| ResolveCredentialRequest | OIDC Convenience Task Credential Offer to issued Credential |
| ResolveTokenRequest | OIDC Convenience Task CallbackUrl to established Connection |
| TokenRequest | - |
Interfaces
| Interface | Description |
|---|---|
| AuthorizationRequestMetadata | - |
| CreateAuthorizationRequestArgs | - |
| CreateCredentialRequestArgs | - |
| FetchAuthServerMetaArgs | - |
| FetchIssuerMetadataArgs | - |
| ParseCredentialOfferArgs | attempt to extract a Credential Offer from the given value |
| ProcessCallbackUrlArgs | - |
| ResolveAuthorizationRequestArgs | - |
| ResolveCredentialRequestArgs | - |
| ResolveTokenRequestArgs | - |
Type Aliases
| Type Alias | Description |
|---|---|
| AuthServerMetadata | - |
| Context | - |
| CredentialOffer | - |
| IssuerMetadata | - |
| Modules | - |
| TokenResponse | - |
Variables
| Variable | Description |
|---|---|
| AuthServerMetadata | - |
| CredentialOffer | - |
| IssuerMetadata | - |
| plugin | - |
| TokenResponse | - |