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

    Interface Reset_authRequestBuilder

    Builds and executes requests for operations under /v2/databases/{database_cluster_uuid}/users/{username}/reset_auth

    interface Reset_authRequestBuilder {
        post(
            body: Reset_authPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Reset_authPostResponse>;
        toPostRequestInformation(
            body: Reset_authPostRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Reset_authRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    post toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: Reset_authPostRequestBody,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Reset_authPostResponse>

      To reset the password for a database user, send a POST request to/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth.For mysql databases, the authentication method can be specifying byincluding a key in the JSON body called mysql_settings with the auth_pluginvalue specified.The response will be a JSON object with a user key. This will be set to anobject containing the standard database user attributes.

      Parameters

      • body: Reset_authPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Reset_authPostResponse>

      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 reset the password for a database user, send a POST request to/v2/databases/$DATABASE_ID/users/$USERNAME/reset_auth.For mysql databases, the authentication method can be specifying byincluding a key in the JSON body called mysql_settings with the auth_pluginvalue specified.The response will be a JSON object with a user key. This will be set to anobject containing the standard database user attributes.

      Parameters

      • body: Reset_authPostRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods