@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
59 lines • 3.21 kB
TypeScript
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import * as operations from "../models/operations/index.js";
export declare class Auth extends ClientSDK {
/**
* Obtains an access token from the Docusign API using an authorization code.
*
* @remarks
* Obtains an access token from the Docusign API using the confidential flow.
* For the developer environment, the URI is https://account-d.docusign.com/oauth/token
* For the production environment, the URI is https://account.docusign.com/oauth/token
* You do not need an integration key to obtain an access token.
*/
getTokenFromConfidentialAuthCode(security: operations.GetTokenFromConfidentialAuthCodeSecurity, request: components.ConfidentialAuthCodeGrantRequestBody, options?: RequestOptions): Promise<components.AuthorizationCodeGrantResponse>;
/**
* Obtains an access token from the Docusign API using an authorization code.
*
* @remarks
* Obtains an access token from the Docusign API using the confidential flow.
* For the developer environment, the URI is https://account-d.docusign.com/oauth/token
* For the production environment, the URI is https://account.docusign.com/oauth/token
* You do not need an integration key to obtain an access token.
*/
getTokenFromPublicAuthCode(request: components.PublicAuthCodeGrantRequestBody, options?: RequestOptions): Promise<components.AuthorizationCodeGrantResponse>;
/**
* Obtains an access token from the Docusign API using a JWT grant.
*
* @remarks
* Obtains an access token from the Docusign API.
*
* For the developer environment, the URI is https://account-d.docusign.com/oauth/token
*
* For the production environment, the URI is https://account.docusign.com/oauth/token
*
* You do not need an integration key to obtain an access token.
*/
getTokenFromJwtGrant(request: operations.JWTGrant, options?: RequestOptions): Promise<components.JWTGrantResponse>;
/**
* Obtains an access token from the Docusign API using an authorization code.
*
* @remarks
* Obtains an access token from the Docusign API.
* For the developer environment, the URI is https://account-d.docusign.com/oauth/token
* For the production environment, the URI is https://account.docusign.com/oauth/token
*
* You do not need an integration key to obtain an access token.
*/
getTokenFromRefreshToken(request: operations.AuthorizationCodeGrant, security?: operations.GetTokenFromRefreshTokenSecurity | undefined, options?: RequestOptions): Promise<operations.GetTokenFromRefreshTokenResponse>;
/**
* Get user information
*
* @remarks
* This endpoint retrieves user information from the Docusign API using an access token.
* For the developer environment, the URI is https://account-d.docusign.com/oauth/userinfo
* For the production environment, the URI is https://account.docusign.com/oauth/userinfo
*/
getUserInfo(options?: RequestOptions): Promise<components.UserInfo>;
}
//# sourceMappingURL=auth.d.ts.map