# InitiateProviderRegistration
<a name="API_InitiateProviderRegistration"></a>

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

## Request Syntax
<a name="API_InitiateProviderRegistration_RequestSyntax"></a>

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

{
   "provider": "string"
}
```

## URI Request Parameters
<a name="API_InitiateProviderRegistration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_InitiateProviderRegistration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [provider](#API_InitiateProviderRegistration_RequestSyntax) **   <a name="securityagent-InitiateProviderRegistration-request-provider"></a>
The provider to initiate registration with. Currently, only GITHUB is supported.  
Type: String  
Valid Values: `GITHUB`   
Required: Yes

## Response Syntax
<a name="API_InitiateProviderRegistration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

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

## Response Elements
<a name="API_InitiateProviderRegistration_ResponseElements"></a>

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](#API_InitiateProviderRegistration_ResponseSyntax) **   <a name="securityagent-InitiateProviderRegistration-response-csrfState"></a>
The CSRF state token to use when completing the OAuth flow.  
Type: String

 ** [redirectTo](#API_InitiateProviderRegistration_ResponseSyntax) **   <a name="securityagent-InitiateProviderRegistration-response-redirectTo"></a>
The URL to redirect the user to for completing the OAuth authorization.  
Type: String

## Errors
<a name="API_InitiateProviderRegistration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_InitiateProviderRegistration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/securityagent-2025-09-06/InitiateProviderRegistration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/securityagent-2025-09-06/InitiateProviderRegistration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/securityagent-2025-09-06/InitiateProviderRegistration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/securityagent-2025-09-06/InitiateProviderRegistration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/securityagent-2025-09-06/InitiateProviderRegistration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/securityagent-2025-09-06/InitiateProviderRegistration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/securityagent-2025-09-06/InitiateProviderRegistration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/securityagent-2025-09-06/InitiateProviderRegistration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/securityagent-2025-09-06/InitiateProviderRegistration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/securityagent-2025-09-06/InitiateProviderRegistration)