SecurityAgent / Client / initiate_provider_registration

initiate_provider_registration

SecurityAgent.Client.initiate_provider_registration(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.initiate_provider_registration(
    provider='GITHUB'
)
Parameters:

provider (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'redirectTo': 'string',
    'csrfState': 'string'
}

Response Structure

  • (dict) –

    • redirectTo (string) –

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

    • csrfState (string) –

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

Exceptions