Get service account credentials

GET /_security/service/{namespace}/{service}/credential

To use this API, you must have at least the read_security cluster privilege (or a greater privilege such as manage_service_account or manage_security).

The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.

NOTE: For tokens backed by the service_tokens file, the API collects them from all nodes of the cluster. Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.

Required authorization

Cluster privileges: read_security

More about service accounts

Path Parameters

Response

application/json

Examples

A successful response from GET /_security/service/elastic/fleet-server/credential. The response contains all credentials for the elastic/fleet-server service account.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_security/service/elastic/fleet-server/credential

JavaScript Elasticsearch JavaScript Client

const response = await client.security.getServiceCredentials({
  namespace: "elastic",
  service: "fleet-server",
});

Python Elasticsearch Python Client

resp = client.security.get_service_credentials(
    namespace="elastic",
    service="fleet-server",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_security/service/elastic/fleet-server/credential" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().getServiceCredentials(g -> g
    .namespace("elastic")
    .service("fleet-server")
);

C# Elasticsearch .NET Client

var response = await client.Security.GetServiceCredentialsAsync(@namespace: "elastic", service: "fleet-server");

PHP Elasticsearch PHP Client

$resp = $client->security()->getServiceCredentials([
    "namespace" => "elastic",
    "service" => "fleet-server",
]);

Ruby Elasticsearch Ruby Client

response = client.security.get_service_credentials(
  namespace: "elastic",
  service: "fleet-server"
)

Response

{
  "service_account": "elastic/fleet-server",
  "count": 3,
  "tokens": {
    "token1": {},        
    "token42": {}        
  },
  "nodes_credentials": { 
    "_nodes": {          
      "total": 3,
      "successful": 3,
      "failed": 0
    },
    "file_tokens": {      
      "my-token": {
        "nodes": [ "node0", "node1" ] 
      }
    }
  }
}

Required authorization

Path Parameters { namespace , service , }

Response

Path Parameters