Skip to main content

CreateCredentialRequestArgs

@hyperledger/identus-sdk v7.0.0

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

Interface: CreateCredentialRequestArgs

Defined in: src/plugins/internal/oidc/tasks/CreateCredentialRequest.ts:10

Properties​

PropertyTypeDescriptionDefined in
clientId?string-src/plugins/internal/oidc/tasks/CreateCredentialRequest.ts:12
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; }-src/plugins/internal/oidc/tasks/CreateCredentialRequest.ts:13
issuerMeta.authorization_servers?string[]-src/plugins/internal/oidc/types.ts:86
issuerMeta.batch_credential_endpoint?string-src/plugins/internal/oidc/types.ts:95
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; }; }-src/plugins/internal/oidc/types.ts:111
issuerMeta.credential_endpointstring-src/plugins/internal/oidc/types.ts:90
issuerMeta.credential_identifiers_supported?boolean-src/plugins/internal/oidc/types.ts:175
issuerMeta.credential_issuerstring-src/plugins/internal/oidc/types.ts:80
issuerMeta.credential_response_encryption?{ alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; }-src/plugins/internal/oidc/types.ts:155
issuerMeta.credential_response_encryption.alg_values_supportedstring[]-src/plugins/internal/oidc/types.ts:159
issuerMeta.credential_response_encryption.enc_values_supportedstring[]-src/plugins/internal/oidc/types.ts:163
issuerMeta.credential_response_encryption.encryption_requiredboolean-src/plugins/internal/oidc/types.ts:169
issuerMeta.deferred_credential_endpoint?string-src/plugins/internal/oidc/types.ts:100
issuerMeta.display?{ }-src/plugins/internal/oidc/types.ts:178
issuerMeta.notification_endpoint?string-src/plugins/internal/oidc/types.ts:105
issuerMeta.signed_metadata?string-src/plugins/internal/oidc/types.ts:108
offer{ credential_configuration_ids: string[]; credential_issuer: string; grants?: { authorization_code?: { authorization_server?: string; issuer_state?: string; }; urn:ietf:params:oauth:grant-type:pre-authorized_code?: { authorization_server?: string; interval?: number; pre-authorized_code: string; tx_code?: { description?: string; input_mode?: string; length?: number; }; }; }; }-src/plugins/internal/oidc/tasks/CreateCredentialRequest.ts:11
offer.credential_configuration_idsstring[]array of unique strings that each identify one of the keys in name/value pairs stored in the credential_configurations_supported Credential Issuer Metadatasrc/plugins/internal/oidc/types.ts:25
offer.credential_issuerstringurl of the Credential Issuer from which the wallet is requested to obtain one or more Credentials the Wallet uses it to obtain the Credential Issuer's Metadatasrc/plugins/internal/oidc/types.ts:20
offer.grants?{ authorization_code?: { authorization_server?: string; issuer_state?: string; }; urn:ietf:params:oauth:grant-type:pre-authorized_code?: { authorization_server?: string; interval?: number; pre-authorized_code: string; tx_code?: { description?: string; input_mode?: string; length?: number; }; }; }indicates the Grant Types the Authorization Server is prepared to process if grants is nil the Wallet must determine the Grant Types using the Metadata when multiple grants are present, it is at the Wallets discretion which to usesrc/plugins/internal/oidc/types.ts:31
offer.grants.authorization_code?{ authorization_server?: string; issuer_state?: string; }-src/plugins/internal/oidc/types.ts:32
offer.grants.authorization_code.authorization_server?stringcan be used to identify the Authorization Server to use with this grant type when authorization_servers in Issuer Metadata has multiple entriessrc/plugins/internal/oidc/types.ts:43
offer.grants.authorization_code.issuer_state?stringused to bind the Authorization Request with the Credential Issuer to a context if the Wallet decides to use the Authorization Code flow and received this value it must be included in the subsequent Authorization Reqestsrc/plugins/internal/oidc/types.ts:38
offer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code?{ authorization_server?: string; interval?: number; pre-authorized_code: string; tx_code?: { description?: string; input_mode?: string; length?: number; }; }-src/plugins/internal/oidc/types.ts:46
offer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.authorization_server?stringcan be used to identify the Authorization Server to use with this grant type when authorization_servers in Issuer Metadata has multiple entriessrc/plugins/internal/oidc/types.ts:63
offer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.interval?numberamount of time in seconds that the Wallet should wait between polling requests to the token endpointsrc/plugins/internal/oidc/types.ts:58
offer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.pre-authorized_codestringcode representing the Issuers authorization short lived and single use if the Wallet decides to use the pre-authorized_code flow, this value must be included in the subsequent Token Requestsrc/plugins/internal/oidc/types.ts:53
offer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code?{ description?: string; input_mode?: string; length?: number; }specifies whether the Authorization Server expects a presentation of a Transaction Code along with the Token Requestsrc/plugins/internal/oidc/types.ts:68
offer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.description?string-src/plugins/internal/oidc/types.ts:71
offer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.input_mode?string-src/plugins/internal/oidc/types.ts:69
offer.grants.urn:ietf:params:oauth:grant-type:pre-authorized_code.tx_code.length?number-src/plugins/internal/oidc/types.ts:70
tokenResponse?{ 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; }-src/plugins/internal/oidc/tasks/CreateCredentialRequest.ts:14
tokenResponse.access_tokenstring-src/plugins/internal/oidc/types.ts:545
tokenResponse.c_nonce?string-src/plugins/internal/oidc/types.ts:548
tokenResponse.c_nonce_expires_in?number-src/plugins/internal/oidc/types.ts:549
tokenResponse.expires_in?number-src/plugins/internal/oidc/types.ts:547
tokenResponse.id_token?string-src/plugins/internal/oidc/types.ts:552
tokenResponse.refresh_expires_in?number-src/plugins/internal/oidc/types.ts:551
tokenResponse.refresh_token?string-src/plugins/internal/oidc/types.ts:550
tokenResponse.scope?string-src/plugins/internal/oidc/types.ts:553
tokenResponse.session_state?string-src/plugins/internal/oidc/types.ts:554
tokenResponse.token_typestring-src/plugins/internal/oidc/types.ts:546