register_oidc_config_test ¶

def register_oidc_config_test(
    self,
    network_id: "capo_wickr.types.network_id.NetworkId",
    issuer: "capo_wickr.types.generic_string.GenericString",
    scopes: "capo_wickr.types.generic_string.GenericString",
    *,
    config_overrides: Optional[WickrClientConfig] = None,
    extra_auth_params: Optional[
        "capo_wickr.types.generic_string.GenericString"
    ] = None,
    certificate: Optional["capo_wickr.types.generic_string.GenericString"] = None,
) -> "capo_wickr.types.register_oidc_config_test_response.RegisterOidcConfigTestResponse":
    """<p>Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.</p>

    Args:
        network_id: <p>The ID of the Wickr network for which the OIDC configuration will be tested.</p>
        extra_auth_params: <p>Additional authentication parameters to include in the test (optional).</p>
        issuer: <p>The issuer URL of the OIDC provider to test.</p>
        scopes: <p>The OAuth scopes to test with the OIDC provider.</p>
        certificate: <p>The CA certificate for secure communication with the OIDC provider (optional).</p>

    Raises:
        capo_wickr.errors.bad_request_error.BadRequestError: <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
        capo_wickr.errors.forbidden_error.ForbiddenError: <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
        capo_wickr.errors.internal_server_error.InternalServerError: <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
        capo_wickr.errors.rate_limit_error.RateLimitError: <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
        capo_wickr.errors.resource_not_found_error.ResourceNotFoundError: <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
        capo_wickr.errors.unauthorized_error.UnauthorizedError: <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
        capo_wickr.errors.validation_error.ValidationError: <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
        capo_wickr.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Test OIDC config successfully

        >>> client.register_oidc_config_test(network_id='12345678', issuer='https://login.example.com', scopes='openid profile email')
        Test OIDC config - missing issuer

        >>> client.register_oidc_config_test(network_id='12345678', issuer='', scopes='openid profile email')
        Test OIDC config - invalid endpoint

        >>> client.register_oidc_config_test(network_id='12345678', issuer='https://blocked-endpoint.com', scopes='openid profile email')
    """

    def _handler(
        req: "OperationRequest[capo_wickr.types.register_oidc_config_test_request.RegisterOidcConfigTestRequest]",
    ) -> OperationResponse[
        "capo_wickr.types.register_oidc_config_test_response.RegisterOidcConfigTestResponse"
    ]:
        import capo_wickr._operations.wickr_admin_api.register_oidc_config_test

        output, http_response = (
            capo_wickr._operations.wickr_admin_api.register_oidc_config_test.register_oidc_config_test(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RegisterOidcConfigTest")
    )
    input_: capo_wickr.types.register_oidc_config_test_request.RegisterOidcConfigTestRequest = {
        "network_id": network_id,
        "issuer": issuer,
        "scopes": scopes,
    }
    if extra_auth_params is not None:
        input_["extra_auth_params"] = extra_auth_params
    if certificate is not None:
        input_["certificate"] = certificate

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