@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface UserRequestBuilder

    Builds and executes requests for operations under /v2/kubernetes/clusters/{cluster_id}/user

    interface UserRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | User>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): UserRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • To show information the user associated with a Kubernetes cluster, send a GETrequest to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/user.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | User>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To show information the user associated with a Kubernetes cluster, send a GETrequest to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/user.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns UserRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods