README.md

Auth

Overview

Available Operations

• getTokenFromConfidentialAuthCode - Obtains an access token from the Docusign API using an authorization code.
• getTokenFromPublicAuthCode - Obtains an access token from the Docusign API using an authorization code.
• getTokenFromJwtGrant - Obtains an access token from the Docusign API using a JWT grant.
• getTokenFromRefreshToken - Obtains an access token from the Docusign API using an authorization code.
• getUserInfo - Get user information

getTokenFromConfidentialAuthCode

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.

Example Usage

package hello.world;

import com.docusign.iam.sdk.IamClient;
import com.docusign.iam.sdk.models.components.ConfidentialAuthCodeGrantRequestBody;
import com.docusign.iam.sdk.models.errors.OAuthErrorResponse;
import com.docusign.iam.sdk.models.operations.GetTokenFromConfidentialAuthCodeResponse;
import com.docusign.iam.sdk.models.operations.GetTokenFromConfidentialAuthCodeSecurity;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws OAuthErrorResponse, Exception {

        IamClient sdk = IamClient.builder()
            .build();

        ConfidentialAuthCodeGrantRequestBody req = ConfidentialAuthCodeGrantRequestBody.builder()
                .code("eyJ0eXAi.....QFsje43QVZ_gw")
                .build();

        GetTokenFromConfidentialAuthCodeResponse res = sdk.auth().getTokenFromConfidentialAuthCode()
                .request(req)
                .security(GetTokenFromConfidentialAuthCodeSecurity.builder()
                    .clientId("2da1cb14-xxxx-xxxx-xxxx-5b7b40829e79")
                    .secretKey("MTIzNDU2Nzxxxxxxxxxxxxxxxxxxxxx0NTY3ODkwMTI")
                    .build())
                .call();

        if (res.authorizationCodeGrantResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	ConfidentialAuthCodeGrantRequestBody	✔️	The request object to use for the request.
security	com.docusign.iam.sdk.models.operations.GetTokenFromConfidentialAuthCodeSecurity	✔️	The security requirements to use for the request.
serverURL	String	➖	An optional server URL to use.

Response

GetTokenFromConfidentialAuthCodeResponse

Errors

Error Type	Status Code	Content Type
models/errors/OAuthErrorResponse	400	application/json
models/errors/APIException	4XX, 5XX	*/*

getTokenFromPublicAuthCode

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.

Example Usage

package hello.world;

import com.docusign.iam.sdk.IamClient;
import com.docusign.iam.sdk.models.components.PublicAuthCodeGrantRequestBody;
import com.docusign.iam.sdk.models.errors.OAuthErrorResponse;
import com.docusign.iam.sdk.models.operations.GetTokenFromPublicAuthCodeResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws OAuthErrorResponse, Exception {

        IamClient sdk = IamClient.builder()
                .accessToken(System.getenv().getOrDefault("ACCESS_TOKEN", ""))
            .build();

        PublicAuthCodeGrantRequestBody req = PublicAuthCodeGrantRequestBody.builder()
                .clientId("2da1cb14-xxxx-xxxx-xxxx-5b7b40829e79")
                .code("eyJ0eXAi.....QFsje43QVZ_gw")
                .codeVerifier("R8zFoqs0yey29G71QITZs3dK1YsdIvFNBfO4D1bukBw")
                .build();

        GetTokenFromPublicAuthCodeResponse res = sdk.auth().getTokenFromPublicAuthCode()
                .request(req)
                .call();

        if (res.authorizationCodeGrantResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	PublicAuthCodeGrantRequestBody	✔️	The request object to use for the request.
serverURL	String	➖	An optional server URL to use.

Response

GetTokenFromPublicAuthCodeResponse

Errors

Error Type	Status Code	Content Type
models/errors/OAuthErrorResponse	400	application/json
models/errors/APIException	4XX, 5XX	*/*

getTokenFromJwtGrant

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.

Example Usage

package hello.world;

import com.docusign.iam.sdk.IamClient;
import com.docusign.iam.sdk.models.errors.OAuthErrorResponse;
import com.docusign.iam.sdk.models.operations.GetTokenFromJWTGrantResponse;
import com.docusign.iam.sdk.models.operations.JWTGrant;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws OAuthErrorResponse, Exception {

        IamClient sdk = IamClient.builder()
                .accessToken(System.getenv().getOrDefault("ACCESS_TOKEN", ""))
            .build();

        JWTGrant req = JWTGrant.builder()
                .assertion("YOUR_JSON_WEB_TOKEN")
                .build();

        GetTokenFromJWTGrantResponse res = sdk.auth().getTokenFromJwtGrant()
                .request(req)
                .call();

        if (res.jwtGrantResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	JWTGrant	✔️	The request object to use for the request.
serverURL	String	➖	An optional server URL to use.

Response

GetTokenFromJWTGrantResponse

Errors

Error Type	Status Code	Content Type
models/errors/OAuthErrorResponse	400	application/json
models/errors/APIException	4XX, 5XX	*/*

getTokenFromRefreshToken

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.

Example Usage

package hello.world;

import com.docusign.iam.sdk.IamClient;
import com.docusign.iam.sdk.models.errors.OAuthErrorResponse;
import com.docusign.iam.sdk.models.operations.AuthorizationCodeGrant;
import com.docusign.iam.sdk.models.operations.GetTokenFromRefreshTokenResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws OAuthErrorResponse, Exception {

        IamClient sdk = IamClient.builder()
            .build();

        AuthorizationCodeGrant req = AuthorizationCodeGrant.builder()
                .refreshToken("<value>")
                .clientId("2da1cb14-xxxx-xxxx-xxxx-5b7b40829e79")
                .build();

        GetTokenFromRefreshTokenResponse res = sdk.auth().getTokenFromRefreshToken()
                .request(req)
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	AuthorizationCodeGrant	✔️	The request object to use for the request.
security	com.docusign.iam.sdk.models.operations.GetTokenFromRefreshTokenSecurity	✔️	The security requirements to use for the request.
serverURL	String	➖	An optional server URL to use.

Response

GetTokenFromRefreshTokenResponse

Errors

Error Type	Status Code	Content Type
models/errors/OAuthErrorResponse	400	application/json
models/errors/APIException	4XX, 5XX	*/*

getUserInfo

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

Example Usage

package hello.world;

import com.docusign.iam.sdk.IamClient;
import com.docusign.iam.sdk.models.errors.OAuthErrorResponse;
import com.docusign.iam.sdk.models.operations.GetUserInfoResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws OAuthErrorResponse, Exception {

        IamClient sdk = IamClient.builder()
                .accessToken(System.getenv().getOrDefault("ACCESS_TOKEN", ""))
            .build();

        GetUserInfoResponse res = sdk.auth().getUserInfo()
                .call();

        if (res.userInfo().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
serverURL	String	➖	An optional server URL to use.

Response

GetUserInfoResponse

Errors

Error Type	Status Code	Content Type
models/errors/OAuthErrorResponse	400	application/json
models/errors/APIException	4XX, 5XX	*/*