OIDCConnection

@hyperledger/identus-sdk v8.0.0

---

@hyperledger/identus-sdk / plugins/internal/oidc / OIDCConnection

Class: OIDCConnection

Defined in: packages/lib/sdk/src/plugins/internal/oidc/connection/OIDCConnection.ts:7

Define the structure of a Connection

Connections are used to capture Protocol specific behaviours and metadata

Implements

• Connection

Constructors

Constructor

new OIDCConnection(issuerMeta: { authorization_servers?: string[]; batch_credential_endpoint?: string; credential_configurations_supported: {[key: string]: { credential_definition: { credentialSubject?: { }; type: string[]; }; credential_signing_alg_values_supported?: string[]; cryptographic_binding_methods_supported?: string[]; format: string; proof_types_supported?: {[key: string]: { proof_signing_alg_values_supported: string[]; }; }; scope?: string; }; }; credential_endpoint: string; credential_identifiers_supported?: boolean; credential_issuer: string; credential_response_encryption?: { alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; }; deferred_credential_endpoint?: string; display?: { }; notification_endpoint?: string; signed_metadata?: string; }, scopes: string[]): OIDCConnection

Defined in: packages/lib/sdk/src/plugins/internal/oidc/connection/OIDCConnection.ts:12

Parameters

Parameter	Type
issuerMeta	{ authorization_servers?: string[]; batch_credential_endpoint?: string; credential_configurations_supported: {[key: string]: { credential_definition: { credentialSubject?: { }; type: string[]; }; credential_signing_alg_values_supported?: string[]; cryptographic_binding_methods_supported?: string[]; format: string; proof_types_supported?: {[key: string]: { proof_signing_alg_values_supported: string[]; }; }; scope?: string; }; }; credential_endpoint: string; credential_identifiers_supported?: boolean; credential_issuer: string; credential_response_encryption?: { alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; }; deferred_credential_endpoint?: string; display?: { }; notification_endpoint?: string; signed_metadata?: string; }
issuerMeta.authorization_servers?	string[]
issuerMeta.batch_credential_endpoint?	string
issuerMeta.credential_configurations_supported	{[key: string]: { credential_definition: { credentialSubject?: { }; type: string[]; }; credential_signing_alg_values_supported?: string[]; cryptographic_binding_methods_supported?: string[]; format: string; proof_types_supported?: {[key: string]: { proof_signing_alg_values_supported: string[]; }; }; scope?: string; }; }
issuerMeta.credential_endpoint	string
issuerMeta.credential_identifiers_supported?	boolean
issuerMeta.credential_issuer	string
issuerMeta.credential_response_encryption?	{ alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; }
issuerMeta.credential_response_encryption.alg_values_supported	string[]
issuerMeta.credential_response_encryption.enc_values_supported	string[]
issuerMeta.credential_response_encryption.encryption_required	boolean
issuerMeta.deferred_credential_endpoint?	string
issuerMeta.display?	{ }
issuerMeta.notification_endpoint?	string
issuerMeta.signed_metadata?	string
scopes	string[]

Returns

OIDCConnection

Properties

Property	Modifier	Type	Default value	Description	Defined in
issuerMeta	readonly	{ authorization_servers?: string[]; batch_credential_endpoint?: string; credential_configurations_supported: {[key: string]: { credential_definition: { credentialSubject?: { }; type: string[]; }; credential_signing_alg_values_supported?: string[]; cryptographic_binding_methods_supported?: string[]; format: string; proof_types_supported?: {[key: string]: { proof_signing_alg_values_supported: string[]; }; }; scope?: string; }; }; credential_endpoint: string; credential_identifiers_supported?: boolean; credential_issuer: string; credential_response_encryption?: { alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; }; deferred_credential_endpoint?: string; display?: { }; notification_endpoint?: string; signed_metadata?: string; }	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/connection/OIDCConnection.ts:13
issuerMeta.authorization_servers?	public	string[]	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:86
issuerMeta.batch_credential_endpoint?	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:95
issuerMeta.credential_configurations_supported	public	{[key: string]: { credential_definition: { credentialSubject?: { }; type: string[]; }; credential_signing_alg_values_supported?: string[]; cryptographic_binding_methods_supported?: string[]; format: string; proof_types_supported?: {[key: string]: { proof_signing_alg_values_supported: string[]; }; }; scope?: string; }; }	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:111
issuerMeta.credential_endpoint	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:90
issuerMeta.credential_identifiers_supported?	public	boolean	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:175
issuerMeta.credential_issuer	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:80
issuerMeta.credential_response_encryption?	public	{ alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; }	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:155
issuerMeta.credential_response_encryption.alg_values_supported	public	string[]	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:159
issuerMeta.credential_response_encryption.enc_values_supported	public	string[]	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:163
issuerMeta.credential_response_encryption.encryption_required	public	boolean	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:169
issuerMeta.deferred_credential_endpoint?	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:100
issuerMeta.display?	public	{ }	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:178
issuerMeta.notification_endpoint?	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:105
issuerMeta.signed_metadata?	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:108
scopes	readonly	string[]	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/connection/OIDCConnection.ts:14
state	public	State	Connection.State.NEW	current condition of the connection	packages/lib/sdk/src/plugins/internal/oidc/connection/OIDCConnection.ts:8
tokenResponse?	public	{ access_token: string; c_nonce?: string; c_nonce_expires_in?: number; expires_in?: number; id_token?: string; refresh_expires_in?: number; refresh_token?: string; scope?: string; session_state?: string; token_type: string; }	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/connection/OIDCConnection.ts:9
tokenResponse.access_token	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:545
tokenResponse.c_nonce?	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:548
tokenResponse.c_nonce_expires_in?	public	number	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:549
tokenResponse.expires_in?	public	number	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:547
tokenResponse.id_token?	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:552
tokenResponse.refresh_expires_in?	public	number	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:551
tokenResponse.refresh_token?	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:550
tokenResponse.scope?	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:553
tokenResponse.session_state?	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:554
tokenResponse.token_type	public	string	undefined	-	packages/lib/sdk/src/plugins/internal/oidc/types.ts:546
uri	readonly	string	undefined	unique identifer for the connection	packages/lib/sdk/src/plugins/internal/oidc/connection/OIDCConnection.ts:10

Methods

send()

send(request: any, ctx: Context): Promise<ApiResponse<unknown> | undefined>

Defined in: packages/lib/sdk/src/plugins/internal/oidc/connection/OIDCConnection.ts:19

handle delivering a Message to the connected entity

Parameters

Parameter	Type
request	any
ctx	Context

Returns

Promise<ApiResponse<unknown> | undefined>

Implementation of

Connection.send