Interface CodeGenQueryParams

interface CodeGenQueryParams {
    claimId?: string;
    client_id: string;
    expectAttestations?: boolean;
    expectVerifySuccess?: boolean;
    hideIfAlreadyClaimed?: boolean;
    redirect_uri?: string;
    scope?: string;
    state?: string;
}

Hierarchy (View Summary)

Properties

claimId? client_id expectAttestations? expectVerifySuccess? hideIfAlreadyClaimed? redirect_uri? scope? state?

Properties

OptionalclaimId

claimId?: string

We will display this claim on the authorize screen. Just for display purpses. This is still to be checked by you post-authentication.

client_id

client_id: string

The client ID to use for the SIWBB request. Must match the one in developer portal.

OptionalexpectAttestations

expectAttestations?: boolean

We will expect the user to provide attestations. Consider adding an additional instructions to the user for which ones to present. You still need to check the attestations on your side.

Deprecated

It is preferred to receive attestations via claims instead.

OptionalexpectVerifySuccess

expectVerifySuccess?: boolean

We will expect the claim verification to succeed. If false, we will not let user attempt to sign in.

Note: This is not a replacement for checking the claim on your side because users can manipulate the client-side URL parameters.

OptionalhideIfAlreadyClaimed

hideIfAlreadyClaimed?: boolean

For the claimId, we will hide the claim if the user has already completed it (successCount >= 1).

Optionalredirect_uri

redirect_uri?: string

The redirect URI to redirect to after the user signs in. Must match the one in developer portal.

Optionalscope

scope?: string

The scopes to request (e.g. completeClaims,approveSignInWithBitBadges).

Optionalstate

state?: string

The state to use for the SIWBB request.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR