List Principals

GET

/api/v1/principals

const url = 'https://example.com/api/v1/principals';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/principals

Responses

200

Successful Response

application/json

Response Principals List Principals

Array<object>

PrincipalSummary

object

required

string

type

required

PrincipalType

string

Allowed values: USER API

name

required

Name

string

extra

required

Extra

object

key

additional properties

any

superuser

required

Superuser

boolean

has_secret

required

Has Secret

boolean

created_by

required

Any of:

string
null

string

created_at

required

Created At

string format: date-time

revoked_by

required

Any of:

string
null

string

revoked_at

required

Any of:

string
null

string format: date-time

Example

[
  {
    "type": "USER"
  }
]