IO Wallet SDK
    Preparing search index...

    Interface ValidateCredentialOfferOptions

    Options for validating a credential offer against the configured IT-Wallet specification.

    interface ValidateCredentialOfferOptions {
        config: IoWalletSdkConfig;
        credentialIssuerMetadata: { authorization_servers?: [string, ...string[]] };
        credentialOffer:
            | {
                credential_configuration_ids: string[];
                credential_issuer: string;
                grants: {
                    authorization_code: {
                        authorization_server?: string;
                        issuer_state?: string;
                        scope: string;
                    };
                };
            }
            | {
                credential_configuration_ids: string[];
                credential_issuer: string;
                grants: {
                    authorization_code: {
                        authorization_server?: string;
                        issuer_state?: string;
                    };
                };
            };
    }

    Hierarchy (View Summary)

    Index

    Properties

    config credentialIssuerMetadata credentialOffer

    Properties

    config: IoWalletSdkConfig
    credentialIssuerMetadata: { authorization_servers?: [string, ...string[]] }

    Optional Credential Issuer metadata for conditional validation.

    Used to validate the authorization_server requirement:

    • If the Credential Issuer uses multiple Authorization Servers, authorization_server MUST be present in the grant and must match one of the authorization_servers in the metadata.
    const metadata = {
      authorization_servers: [
        "https://auth1.issuer.example.com",
        "https://auth2.issuer.example.com"
      ]
    };
    credentialOffer:
        | {
            credential_configuration_ids: string[];
            credential_issuer: string;
            grants: {
                authorization_code: {
                    authorization_server?: string;
                    issuer_state?: string;
                    scope: string;
                };
            };
        }
        | {
            credential_configuration_ids: string[];
            credential_issuer: string;
            grants: {
                authorization_code: {
                    authorization_server?: string;
                    issuer_state?: string;
                };
            };
        }

    The credential offer to validate against the configured IT-Wallet specification.

    Type Declaration

    • {
          credential_configuration_ids: string[];
          credential_issuer: string;
          grants: {
              authorization_code: {
                  authorization_server?: string;
                  issuer_state?: string;
                  scope: string;
              };
          };
      }
      • credential_configuration_ids: string[]

        REQUIRED. Array of credential configuration identifiers. References the types of credentials offered as defined in the Credential Issuer metadata.

      • credential_issuer: string

        REQUIRED. HTTPS URL of the Credential Issuer. The Credential Issuer from which the wallet will request credentials.

      • grants: {
            authorization_code: {
                authorization_server?: string;
                issuer_state?: string;
                scope: string;
            };
        }

        REQUIRED. Grant information for the credential offer. IT-Wallet v1.3 requires authorization_code grant.

        • authorization_code: { authorization_server?: string; issuer_state?: string; scope: string }

          REQUIRED. Authorization Code grant details. IT-Wallet v1.3 only supports authorization_code grant.

          • Optionalauthorization_server?: string

            CONDITIONALLY REQUIRED. HTTPS URL of the Authorization Server. REQUIRED only when the Credential Issuer uses multiple Authorization Servers. If present, MUST match one of the authorization_servers in the Credential Issuer metadata.

          • Optionalissuer_state?: string

            OPTIONAL. String value representing the issuer state. Used to correlate the authorization request with the credential offer.

          • scope: string

            REQUIRED. OAuth 2.0 scope value. Defines the scope of access requested by the credential offer.

    • {
          credential_configuration_ids: string[];
          credential_issuer: string;
          grants: {
              authorization_code: {
                  authorization_server?: string;
                  issuer_state?: string;
              };
          };
      }
      • credential_configuration_ids: string[]

        REQUIRED. Array of credential configuration identifiers. References the types of credentials offered as defined in the Credential Issuer metadata.

      • credential_issuer: string

        REQUIRED. HTTPS URL of the Credential Issuer. The Credential Issuer from which the wallet will request credentials.

      • grants: { authorization_code: { authorization_server?: string; issuer_state?: string } }

        REQUIRED. Grant information for the credential offer. IT-Wallet v1.4 requires authorization_code grant.

        • authorization_code: { authorization_server?: string; issuer_state?: string }

          REQUIRED. Authorization Code grant details. IT-Wallet v1.4 only supports authorization_code grant.

          • Optionalauthorization_server?: string

            CONDITIONALLY REQUIRED. HTTPS URL of the Authorization Server. REQUIRED only when the Credential Issuer uses multiple Authorization Servers. If present, MUST match one of the authorization_servers in the Credential Issuer metadata.

          • Optionalissuer_state?: string

            OPTIONAL. String value representing the issuer state. Used to correlate the authorization request with the credential offer.

    Settings

    Member Visibility

    On This Page

    Properties