Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

InitiateProviderRegistration

Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.

Request Syntax


POST /oauth2/provider/register HTTP/1.1
Content-type: application/json

{
   "provider": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

provider

The provider to initiate registration with. Currently, only GITHUB is supported.

Type: String

Valid Values: GITHUB

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "csrfState": "string",
   "redirectTo": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

csrfState

The CSRF state token to use when completing the OAuth flow.

Type: String

redirectTo

The URL to redirect the user to for completing the OAuth authorization.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be completed due to a conflict with the current state of the resource.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during the processing of your request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400