GetOAuthAuthorizationURL
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
Input
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the DocuSign app settings. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the DocuSign authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Scope | String | False | When using admin consent, the value of the scope parameter should be openid. This causes the organization IDs of the organizations who are consenting to the requested admin scopes on behalf of their members to be recorded in the response. |
| Grant_Type | String | False | The type of authorization to be granted for your app. If this is set to code, the stored procedure will return an authorization URL containing the verifier code in a query string parameter, which you will need to submit back with the GetOAuthAccessToken stored procedure. Implicit will cause the OAuth access token to be returned directly in the URL.
使用できる値は次のとおりです。Implicit, Code |
| AdminConsentScope | String | False | The scope of the permissions being requested for the application from each user in the organization. Formatted in a space-separated list of the following values: signature - Allows your application to create and send envelopes, and obtain links for starting signing sessions. extended - Issues your application a refresh token that can be used any number of times. This scope may only be granted in the Authorization Code flow. |
Result Set Columns
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |