Contact UsGet started

Managed Service for Elasticsearch API, gRPC: AuthService.UpdateProvider

Written by
Updated at October 17, 2024

Updates registered auth provider.

gRPC request

rpc UpdateProvider (UpdateAuthProviderRequest) returns (operation.Operation)

UpdateAuthProviderRequest

{
  "clusterId": "string",
  "name": "string",
  "provider": {
    "type": "Type",
    "name": "string",
    "order": "int64",
    "enabled": "bool",
    "hidden": "bool",
    "description": "string",
    "hint": "string",
    "icon": "string",
    // Includes only one of the fields `saml`
    "saml": {
      "idpEntityId": "string",
      "idpMetadataFile": "bytes",
      "spEntityId": "string",
      "kibanaUrl": "string",
      "attributePrincipal": "string",
      "attributeGroups": "string",
      "attributeName": "string",
      "attributeEmail": "string",
      "attributeDn": "string"
    }
    // end of the list of possible fields
  }
}

Field

Description

clusterId

string

Required field. Required. ID of the ElasticSearch cluster.

name

string

Required field. Required. Name of the provider to update.

provider

AuthProvider

Required field. Required. New provider defenition.

AuthProvider

Field

Description

type

enum Type

  • TYPE_UNSPECIFIED
  • NATIVE
  • SAML

name

string

order

int64

enabled

bool

hidden

bool

selector ui settings

description

string

hint

string

icon

string

saml

SamlSettings

Includes only one of the fields saml.

SamlSettings

Field

Description

idpEntityId

string

idpMetadataFile

bytes

spEntityId

string

kibanaUrl

string

attributePrincipal

string

attributeGroups

string

attributeName

string

attributeEmail

string

attributeDn

string

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "clusterId": "string",
    "names": [
      "string"
    ]
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "providers": [
      {
        "type": "Type",
        "name": "string",
        "order": "int64",
        "enabled": "bool",
        "hidden": "bool",
        "description": "string",
        "hint": "string",
        "icon": "string",
        // Includes only one of the fields `saml`
        "saml": {
          "idpEntityId": "string",
          "idpMetadataFile": "bytes",
          "spEntityId": "string",
          "kibanaUrl": "string",
          "attributePrincipal": "string",
          "attributeGroups": "string",
          "attributeName": "string",
          "attributeEmail": "string",
          "attributeDn": "string"
        }
        // end of the list of possible fields
      }
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateAuthProvidersMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

AuthProviders

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateAuthProvidersMetadata

Field

Description

clusterId

string

ID of the ElasticSearch cluster.

names[]

string

Names of the providers being added.

AuthProviders

Field

Description

providers[]

AuthProvider

AuthProvider

Field

Description

type

enum Type

  • TYPE_UNSPECIFIED
  • NATIVE
  • SAML

name

string

order

int64

enabled

bool

hidden

bool

selector ui settings

description

string

hint

string

icon

string

saml

SamlSettings

Includes only one of the fields saml.

SamlSettings

Field

Description

idpEntityId

string

idpMetadataFile

bytes

spEntityId

string

kibanaUrl

string

attributePrincipal

string

attributeGroups

string

attributeName

string

attributeEmail

string

attributeDn

string
Previous
DeleteProviders
Next
DeleteProvider