Continuum / Client / start_integration_authorization

start_integration_authorization

Continuum.Client.start_integration_authorization(**kwargs)

Starts an OAuth authorization for a new integration and returns the values the caller sends to the provider’s authorization endpoint. The authorization belongs to the calling AWS account, can be redeemed once by CreateIntegration from that same account, and expires after ten minutes.

See also: AWS API Documentation

Request Syntax

response = client.start_integration_authorization(
    providerType='GITHUB',
    name='string'
)
Parameters:

  • providerType (string) –

    [REQUIRED]

    The provider to authorize. Only GITHUB is supported.

  • name (string) – The name the integration will be created with. When specified, the request fails with ConflictException if an integration with this name already exists in the account, before the caller leaves for the provider. The name is only checked: it is not reserved, stored, or authorized. CreateIntegration requires its own name, checks it again, and may use a different one.

Return type:

dict

Returns:

Response Syntax

{
    'state': 'string',
    'codeChallenge': 'string',
    'codeChallengeMethod': 'S256',
    'expiresAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    Contains the values to send to the provider’s authorization endpoint.

    • state (string) –

      An opaque value to send as the OAuth state parameter. Pass the value the provider returns in its callback to CreateIntegration as authorization.state.

    • codeChallenge (string) –

      The PKCE code challenge to send as the OAuth code_challenge parameter.

    • codeChallengeMethod (string) –

      The PKCE challenge method to send as the OAuth code_challenge_method parameter.

    • expiresAt (datetime) –

      The time after which CreateIntegration no longer accepts this authorization.

Exceptions