initiate_provider_registration ¶

def initiate_provider_registration(
    self,
    provider: "capo_securityagent.types.provider.Provider",
    *,
    config_overrides: Optional[SecurityAgentClientConfig] = None,
    target_url: Optional["capo_securityagent.types.target_url.TargetUrl"] = None,
    organization_name: Optional[str] = None,
    client_id: Optional["capo_securityagent.types.client_id.ClientId"] = None,
    client_secret: Optional[
        "capo_securityagent.types.client_secret.ClientSecret"
    ] = None,
) -> "capo_securityagent.types.initiate_provider_registration_output.InitiateProviderRegistrationOutput":
    """<p>Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.</p>

    Args:
        provider: <p>The provider to initiate registration with.</p>
        target_url: <p>The HTTPS URL of a self-managed provider instance. Omit for SaaS providers.</p>
        organization_name: <p>The name of the organization to connect.</p>
        client_id: <p>The client ID of the OAuth application registered on your self-managed provider instance.</p>
        client_secret: <p>The client secret of the OAuth application registered on your self-managed provider instance.</p>

    Raises:
        capo_securityagent.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_securityagent.errors.conflict_exception.ConflictException: <p>The request could not be completed due to a conflict with the current state of the resource.</p>
        capo_securityagent.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of your request.</p>
        capo_securityagent.errors.resource_not_found_exception.ResourceNotFoundException: <p>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.</p>
        capo_securityagent.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_securityagent.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_securityagent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_securityagent.types.initiate_provider_registration_input.InitiateProviderRegistrationInput]",
    ) -> OperationResponse[
        "capo_securityagent.types.initiate_provider_registration_output.InitiateProviderRegistrationOutput"
    ]:
        import capo_securityagent._operations.security_agent.initiate_provider_registration

        output, http_response = (
            capo_securityagent._operations.security_agent.initiate_provider_registration.initiate_provider_registration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_securityagent.types.initiate_provider_registration_input.InitiateProviderRegistrationInput",
    ) -> dict[str, Any]:
        import capo_securityagent.types.initiate_provider_registration_input

        return capo_securityagent.types.initiate_provider_registration_input.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "InitiateProviderRegistration", redact_input=_redact_input
        ),
    )
    input_: capo_securityagent.types.initiate_provider_registration_input.InitiateProviderRegistrationInput = {
        "provider": provider
    }
    if target_url is not None:
        input_["target_url"] = target_url
    if organization_name is not None:
        input_["organization_name"] = organization_name
    if client_id is not None:
        input_["client_id"] = client_id
    if client_secret is not None:
        input_["client_secret"] = client_secret

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output