@dfns/sdk 0.7.12-rc.1 → 0.7.13-rc.0

package/dfnsError.d.ts

@@ -1,8 +1,8 @@
 export declare class DfnsError extends Error {
     httpStatus: number;
-    context?: unknown;
+    context?: unknown | undefined;
     name: string;
-    constructor(httpStatus: number, message: string, context?: unknown);
+    constructor(httpStatus: number, message: string, context?: unknown | undefined);
     toString(): string;
 }
 export declare class PolicyPendingError extends DfnsError {

package/generated/auth/client.d.ts

@@ -70,6 +70,7 @@ export declare class AuthClient {
     sendRecoveryCode(request: T.SendRecoveryCodeRequest): Promise<T.SendRecoveryCodeResponse>;
     socialLogin(request: T.SocialLoginRequest): Promise<T.SocialLoginResponse>;
     sSOLogin(request: T.SSOLoginRequest): Promise<T.SSOLoginResponse>;
+    sSOLoginInit(request: T.SSOLoginInitRequest): Promise<T.SSOLoginInitResponse>;
     updatePersonalAccessToken(request: T.UpdatePersonalAccessTokenRequest): Promise<T.UpdatePersonalAccessTokenResponse>;
     updateServiceAccount(request: T.UpdateServiceAccountRequest): Promise<T.UpdateServiceAccountResponse>;
     updateUser(request: T.UpdateUserRequest): Promise<T.UpdateUserResponse>;

package/generated/auth/client.js

@@ -622,6 +622,18 @@ class AuthClient {
         });
         return response.json();
     }
+    async sSOLoginInit(request) {
+        const path = (0, url_1.buildPathAndQuery)('/auth/login/sso/init', {
+            path: request ?? {},
+            query: {},
+        });
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'POST',
+            body: request.body,
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
     async updatePersonalAccessToken(request) {
         const path = (0, url_1.buildPathAndQuery)('/auth/pats/:tokenId', {
             path: request ?? {},

package/generated/auth/delegatedClient.d.ts

@@ -82,6 +82,7 @@ export declare class DelegatedAuthClient {
     sendRecoveryCode(request: T.SendRecoveryCodeRequest): Promise<T.SendRecoveryCodeResponse>;
     socialLogin(request: T.SocialLoginRequest): Promise<T.SocialLoginResponse>;
     sSOLogin(request: T.SSOLoginRequest): Promise<T.SSOLoginResponse>;
+    sSOLoginInit(request: T.SSOLoginInitRequest): Promise<T.SSOLoginInitResponse>;
     updatePersonalAccessTokenInit(request: T.UpdatePersonalAccessTokenRequest): Promise<UserActionChallengeResponse>;
     updatePersonalAccessTokenComplete(request: T.UpdatePersonalAccessTokenRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.UpdatePersonalAccessTokenResponse>;
     updateServiceAccountInit(request: T.UpdateServiceAccountRequest): Promise<UserActionChallengeResponse>;

package/generated/auth/delegatedClient.js

@@ -890,6 +890,18 @@ class DelegatedAuthClient {
         });
         return response.json();
     }
+    async sSOLoginInit(request) {
+        const path = (0, url_1.buildPathAndQuery)('/auth/login/sso/init', {
+            path: request ?? {},
+            query: {},
+        });
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'POST',
+            body: request.body,
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
     async updatePersonalAccessTokenInit(request) {
         const path = (0, url_1.buildPathAndQuery)('/auth/pats/:tokenId', {
             path: request ?? {},

package/generated/auth/types.d.ts

@@ -15,6 +15,7 @@ export type ActivatePersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
+    /** Access token kind */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -57,6 +58,7 @@ export type ActivateServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
+        /** Access token kind */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -104,6 +106,7 @@ export type ArchivePersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
+    /** Access token kind */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -146,6 +149,7 @@ export type ArchiveServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
+        /** Access token kind */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -214,27 +218,27 @@ export type CreateCredentialBody = {
     credentialName: string;
     challengeIdentifier: string;
 } | {
-    credentialKind: "Password";
+    credentialKind: "RecoveryKey";
     credentialInfo: {
-        password: string;
+        credId: string;
+        clientData: string;
+        attestationData: string;
     };
+    encryptedPrivateKey?: string | undefined;
     credentialName: string;
     challengeIdentifier: string;
 } | {
-    credentialKind: "Totp";
+    credentialKind: "Password";
     credentialInfo: {
-        otpCode: string;
+        password: string;
     };
     credentialName: string;
     challengeIdentifier: string;
 } | {
-    credentialKind: "RecoveryKey";
+    credentialKind: "Totp";
     credentialInfo: {
-        credId: string;
-        clientData: string;
-        attestationData: string;
+        otpCode: string;
     };
-    encryptedPrivateKey?: string | undefined;
     credentialName: string;
     challengeIdentifier: string;
 };
@@ -256,35 +260,6 @@ export type CreateCredentialChallengeBody = {
     kind: "Fido2" | "Key" | "Password" | "Totp" | "RecoveryKey" | "PasswordProtectedKey";
 };
 export type CreateCredentialChallengeResponse = {
-    kind: "Password";
-    user: {
-        id: string;
-        displayName: string;
-        name: string;
-    };
-    challengeIdentifier: string;
-    rp?: {
-        id: string;
-        name: string;
-    } | undefined;
-    /** @deprecated use challengeIdentifier instead */
-    temporaryAuthenticationToken: string;
-} | {
-    kind: "Totp";
-    user: {
-        id: string;
-        displayName: string;
-        name: string;
-    };
-    challengeIdentifier: string;
-    rp?: {
-        id: string;
-        name: string;
-    } | undefined;
-    otpUrl: string;
-    /** @deprecated use challengeIdentifier instead */
-    temporaryAuthenticationToken: string;
-} | {
     kind: "Fido2";
     user: {
         id: string;
@@ -374,15 +349,7 @@ export type CreateCredentialChallengeResponse = {
     }[];
     /** @deprecated use challengeIdentifier instead */
     temporaryAuthenticationToken: string;
-};
-export type CreateCredentialChallengeRequest = {
-    body: CreateCredentialChallengeBody;
-};
-export type CreateCredentialChallengeWithCodeBody = {
-    credentialKind: "Fido2" | "Key" | "Password" | "Totp" | "RecoveryKey" | "PasswordProtectedKey";
-    code: string;
-};
-export type CreateCredentialChallengeWithCodeResponse = {
+} | {
     kind: "Password";
     user: {
         id: string;
@@ -411,7 +378,15 @@ export type CreateCredentialChallengeWithCodeResponse = {
     otpUrl: string;
     /** @deprecated use challengeIdentifier instead */
     temporaryAuthenticationToken: string;
-} | {
+};
+export type CreateCredentialChallengeRequest = {
+    body: CreateCredentialChallengeBody;
+};
+export type CreateCredentialChallengeWithCodeBody = {
+    credentialKind: "Fido2" | "Key" | "Password" | "Totp" | "RecoveryKey" | "PasswordProtectedKey";
+    code: string;
+};
+export type CreateCredentialChallengeWithCodeResponse = {
     kind: "Fido2";
     user: {
         id: string;
@@ -501,6 +476,35 @@ export type CreateCredentialChallengeWithCodeResponse = {
     }[];
     /** @deprecated use challengeIdentifier instead */
     temporaryAuthenticationToken: string;
+} | {
+    kind: "Password";
+    user: {
+        id: string;
+        displayName: string;
+        name: string;
+    };
+    challengeIdentifier: string;
+    rp?: {
+        id: string;
+        name: string;
+    } | undefined;
+    /** @deprecated use challengeIdentifier instead */
+    temporaryAuthenticationToken: string;
+} | {
+    kind: "Totp";
+    user: {
+        id: string;
+        displayName: string;
+        name: string;
+    };
+    challengeIdentifier: string;
+    rp?: {
+        id: string;
+        name: string;
+    } | undefined;
+    otpUrl: string;
+    /** @deprecated use challengeIdentifier instead */
+    temporaryAuthenticationToken: string;
 };
 export type CreateCredentialChallengeWithCodeRequest = {
     body: CreateCredentialChallengeWithCodeBody;
@@ -545,27 +549,27 @@ export type CreateCredentialWithCodeBody = {
     credentialName: string;
     challengeIdentifier: string;
 } | {
-    credentialKind: "Password";
+    credentialKind: "RecoveryKey";
     credentialInfo: {
-        password: string;
+        credId: string;
+        clientData: string;
+        attestationData: string;
     };
+    encryptedPrivateKey?: string | undefined;
     credentialName: string;
     challengeIdentifier: string;
 } | {
-    credentialKind: "Totp";
+    credentialKind: "Password";
     credentialInfo: {
-        otpCode: string;
+        password: string;
     };
     credentialName: string;
     challengeIdentifier: string;
 } | {
-    credentialKind: "RecoveryKey";
+    credentialKind: "Totp";
     credentialInfo: {
-        credId: string;
-        clientData: string;
-        attestationData: string;
+        otpCode: string;
     };
-    encryptedPrivateKey?: string | undefined;
     credentialName: string;
     challengeIdentifier: string;
 };
@@ -855,6 +859,7 @@ export type CreateServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
+        /** Access token kind */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -915,9 +920,13 @@ export type CreateSocialRegistrationChallengeRequest = {
     body: CreateSocialRegistrationChallengeBody;
 };
 export type CreateUserBody = {
+    /** The email address of the new user. */
     email: string;
+    /** The kind of user being created.
+          In this endpoint it can only be "`CustomerEmployee`" (creating an "`EndUser`" is done through the [Delegated Registration](https://docs.dfns.co/api-reference/auth/registration-flows#delegated-users-registration-flow) endpoint) */
     kind: "CustomerEmployee" | "DfnsStaff";
     publicKey?: string | undefined;
+    /** Value that can be used to correlate the entity with an external system. */
     externalId?: string | undefined;
     /** If set to true, the user will have to authenticate via SSO */
     isSSORequired?: boolean;
@@ -985,7 +994,9 @@ export type CreateUserActionChallengeRequest = {
     body: CreateUserActionChallengeBody;
 };
 export type CreateUserActionSignatureBody = {
+    /** Temporary authentication token returned by the [Create User Action Signature Challenge](https://docs.dfns.co/api-reference/auth/create-user-action-challenge) */
     challengeIdentifier: string;
+    /** First factor credential used to sign the user action */
     firstFactor: {
         kind: "Fido2";
         credentialAssertion: {
@@ -1016,6 +1027,7 @@ export type CreateUserActionSignatureBody = {
             algorithm?: string | undefined;
         };
     };
+    /** Second factor credential used to authenticate a user */
     secondFactor?: ({
         kind: "Fido2";
         credentialAssertion: {
@@ -1070,6 +1082,7 @@ export type DeactivatePersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
+    /** Access token kind */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -1112,6 +1125,7 @@ export type DeactivateServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
+        /** Access token kind */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -1182,6 +1196,7 @@ export type GetApplicationResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
+        /** Access token kind */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -1228,6 +1243,7 @@ export type GetPersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
+    /** Access token kind */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -1270,6 +1286,7 @@ export type GetServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
+        /** Access token kind */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -1329,6 +1346,7 @@ export type ListApplicationsResponse = {
             dateCreated: string;
             credId: string;
             isActive: boolean;
+            /** Access token kind */
             kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
             linkedUserId: string;
             linkedAppId: string;
@@ -1373,6 +1391,7 @@ export type ListPersonalAccessTokensResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
+        /** Access token kind */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;
@@ -1413,6 +1432,7 @@ export type ListServiceAccountsResponse = {
             dateCreated: string;
             credId: string;
             isActive: boolean;
+            /** Access token kind */
             kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
             linkedUserId: string;
             linkedAppId: string;
@@ -1460,7 +1480,9 @@ export type ListUsersRequest = {
     query?: ListUsersQuery;
 };
 export type LoginBody = {
+    /** Temporary authentication token returned by the [Create User Action Signature Challenge](https://docs.dfns.co/api-reference/auth/create-user-action-challenge) */
     challengeIdentifier: string;
+    /** First factor credential used to sign the user action */
     firstFactor: {
         kind: "Fido2";
         credentialAssertion: {
@@ -1491,6 +1513,7 @@ export type LoginBody = {
             algorithm?: string | undefined;
         };
     };
+    /** Second factor credential used to authenticate a user */
     secondFactor?: ({
         kind: "Fido2";
         credentialAssertion: {
@@ -1525,7 +1548,7 @@ export type LoginBody = {
 export type LoginResponse = {
     token: string;
 } | {
-    ssoRedirectUrl: string;
+    ssoClientId: string;
 };
 export type LoginRequest = {
     body: LoginBody;
@@ -1614,6 +1637,7 @@ export type RecoverBody = {
             encryptedPrivateKey: string;
             credentialName?: string | undefined;
         }) | undefined;
+        /** Register a recovery key. See [Account Recovery](https://docs.dfns.co/api-reference/auth/account-recovery) for more details. */
         recoveryCredential?: {
             credentialKind: "RecoveryKey";
             credentialInfo: {
@@ -1706,6 +1730,7 @@ export type RegisterBody = {
         encryptedPrivateKey: string;
         credentialName?: string | undefined;
     }) | undefined;
+    /** Register a recovery key. See [Account Recovery](https://docs.dfns.co/api-reference/auth/account-recovery) for more details. */
     recoveryCredential?: {
         credentialKind: "RecoveryKey";
         credentialInfo: {
@@ -1797,6 +1822,7 @@ export type RegisterEndUserBody = {
         encryptedPrivateKey: string;
         credentialName?: string | undefined;
     }) | undefined;
+    /** Register a recovery key. See [Account Recovery](https://docs.dfns.co/api-reference/auth/account-recovery) for more details. */
     recoveryCredential?: {
         credentialKind: "RecoveryKey";
         credentialInfo: {
@@ -1827,21 +1853,34 @@ export type RegisterEndUserResponse = {
         token: string;
     };
     wallets: {
+        /** ID of the wallet. */
         id: string;
+        /** Network this wallet is bound to. */
         network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
+        /** Wallet address on its corresponding network. */
         address?: string | undefined;
+        /** Details about the key underlying the wallet. */
         signingKey: {
             id: string;
+            /** Key scheme. */
             scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
             curve: "ed25519" | "secp256k1" | "stark";
+            /** Hex-encoded value of the public key. */
             publicKey: string;
+            /** The end user ID the key (and wallet) is delegated to. */
             delegatedTo?: string | undefined;
         };
+        /** Wallet status. */
         status: "Active" | "Archived";
+        /** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
         dateCreated: string;
+        /** Wallet nickname. */
         name?: string | undefined;
+        /** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
         custodial: boolean;
+        /** User-defined value that can be used to correlate the entity with an external system. */
         externalId?: string | undefined;
+        /** List of tags. */
         tags: string[];
         /** Id of the validator on which the wallet is created for Canton networks */
         validatorId?: string | undefined;
@@ -1892,11 +1931,10 @@ export type SocialLoginRequest = {
     body: SocialLoginBody;
 };
 export type SSOLoginBody = {
-    orgId: string;
     /** Authorization code obtained from the IdP */
     code: string;
-    /** Redirect URI used in the initial authorization request */
-    redirectUri: string;
+    /** State forwarded by the IdP */
+    state: string;
 };
 export type SSOLoginResponse = {
     token: string;
@@ -1904,6 +1942,20 @@ export type SSOLoginResponse = {
 export type SSOLoginRequest = {
     body: SSOLoginBody;
 };
+export type SSOLoginInitBody = {
+    orgId: string;
+    /** Client Id obtained from the IdP */
+    clientId: string;
+    /** Redirect URI used for the authentication flow */
+    redirectUri: string;
+};
+export type SSOLoginInitResponse = {
+    /** The URL to redirect the user to authenticate with the IdP */
+    ssoRedirectUrl: string;
+};
+export type SSOLoginInitRequest = {
+    body: SSOLoginInitBody;
+};
 export type UpdatePersonalAccessTokenBody = {
     name?: string | undefined;
     externalId?: string | undefined;
@@ -1916,6 +1968,7 @@ export type UpdatePersonalAccessTokenResponse = {
     dateCreated: string;
     credId: string;
     isActive: boolean;
+    /** Access token kind */
     kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
     linkedUserId: string;
     linkedAppId: string;
@@ -1964,6 +2017,7 @@ export type UpdateServiceAccountResponse = {
         dateCreated: string;
         credId: string;
         isActive: boolean;
+        /** Access token kind */
         kind: "Pat" | "ServiceAccount" | "Token" | "Code" | "Recovery" | "Temp" | "Application";
         linkedUserId: string;
         linkedAppId: string;