get_oidc_info async ¶

async def get_oidc_info(
    self,
    network_id: "capo_wickr.types.network_id.NetworkId",
    *,
    config_overrides: Optional[AsyncWickrClientConfig] = None,
    client_id: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    code: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    grant_type: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    redirect_uri: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    url: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    client_secret: Optional[
        "capo_wickr.types.sensitive_string.SensitiveString"
    ] = None,
    code_verifier: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    certificate: Optional["capo_wickr.types.generic_string.GenericString"] = None,
) -> "capo_wickr.types.get_oidc_info_response.GetOidcInfoResponse":
    """<p>Retrieves the OpenID Connect (OIDC) configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.</p>

    Args:
        network_id: <p>The ID of the Wickr network whose OIDC configuration will be retrieved.</p>
        client_id: <p>The OAuth client ID for retrieving access tokens (optional).</p>
        code: <p>The authorization code for retrieving access tokens (optional).</p>
        grant_type: <p>The OAuth grant type for retrieving access tokens (optional).</p>
        redirect_uri: <p>The redirect URI for the OAuth flow (optional).</p>
        url: <p>The URL for the OIDC provider (optional).</p>
        client_secret: <p>The OAuth client secret for retrieving access tokens (optional).</p>
        code_verifier: <p>The PKCE code verifier for enhanced security in the OAuth flow (optional).</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:
        Get OIDC info successfully

        >>> await client.get_oidc_info(network_id='12345678')
        Get OIDC info - not configured

        >>> await client.get_oidc_info(network_id='12345678')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_wickr.types.get_oidc_info_request.GetOidcInfoRequest]",
    ) -> AsyncOperationResponse[
        "capo_wickr.types.get_oidc_info_response.GetOidcInfoResponse"
    ]:
        import capo_wickr._operations.wickr_admin_api.get_oidc_info

        (
            output,
            http_response,
        ) = await capo_wickr._operations.wickr_admin_api.get_oidc_info.async_get_oidc_info(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_wickr.types.get_oidc_info_request.GetOidcInfoRequest",
    ) -> dict[str, Any]:
        import capo_wickr.types.get_oidc_info_request

        return capo_wickr.types.get_oidc_info_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_wickr.types.get_oidc_info_response.GetOidcInfoResponse",
    ) -> dict[str, Any]:
        import capo_wickr.types.get_oidc_info_response

        return capo_wickr.types.get_oidc_info_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "GetOidcInfo", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_wickr.types.get_oidc_info_request.GetOidcInfoRequest = {
        "network_id": network_id
    }
    if client_id is not None:
        input_["client_id"] = client_id
    if code is not None:
        input_["code"] = code
    if grant_type is not None:
        input_["grant_type"] = grant_type
    if redirect_uri is not None:
        input_["redirect_uri"] = redirect_uri
    if url is not None:
        input_["url"] = url
    if client_secret is not None:
        input_["client_secret"] = client_secret
    if code_verifier is not None:
        input_["code_verifier"] = code_verifier
    if certificate is not None:
        input_["certificate"] = certificate

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output