List credentials for a cluster

GET

/database/clusters/{clusterId}/credentials

List credentials for a clusters.

Authorizations

• publicOauth2
  read:database

Parameters

Path Parameters

clusterId

required

string

format: uuid

A cluster ID.

Query Parameters

limit

integer

default: 10

>= 1

<= 100

The maximum number of items to return in a single response. Used for pagination. Must be between 1 and 100.

Example

Example:

10

offset

integer

The number of items to skip before starting to return results. Used for pagination. For example, to get the next 10 items after the first 10, set offset to 10.

Responses

200

A collection of cluster credentials

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

object

count

required

Number of items returned in the result.

integer

Example:

1

count

required

Number of items returned in the current result set.

integer

Example:

10

meta

required

Pagination metadata for collection responses

object

total

required

Total number of items available

integer

Example:

1000

limit

required

Maximum number of items per page

integer

Example:

10

offset

required

Number of items skipped before the current result set

integer

Example:

10

credentials

required

Array

object

id

required

Unique identifier for this resource within Aerospike Cloud

string

Example:

e2e81cba-446e-4ff9-9b92-9a9992af44c6

name

required

Allowed values:

null

acs-admin

admin

cluster-manager

aerospike-prometheus-exporter

aerospike-collectinfo

dataplane-agent

read

write

read-write

read-write-udf

truncate

data-admin

sindex-admin

sys-admin

udf-admin

user-admin

roles

required

A list of privileges granted to these credentials

Array<string>

default: read-write

>= 1 items

unique items

Allowed values:

read

write

read-write

read-write-udf

truncate

data-admin

sindex-admin

udf-admin

status

required

The status of a user credential

string

Allowed values:

creating

active

failed

revoked

Example:

active

createdAt

required

Timestamp when the resource was created

string

format: date-time

Example

Content type: application/json

Copied!

{ 

{

"count": 10,

"meta": { 

"total": 1000,

"limit": 10,

"offset": 10

},

"credentials": [ 

{ 

"id": "e2e81cba-446e-4ff9-9b92-9a9992af44c6",

"name": "a-user-name",

"roles": [ 

"read"

],

"createdAt": "string"

}

]

}

400

Invalid input

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

401

Access token is missing or invalid

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "invalid_token",

"message": "The access token expired."

}

403

Permission denied

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

404

Resource not found

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

500

Internal Server Error

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}