List auths
Returns a paginated list of auths in a gateway. Personal (owned) keys are excluded unless owner_id or owned=true asks for them; each owned key carries owner_id and, when it has one, its budget. A group key, one held for a directory group, also carries group_id and group_name.
GET
/
v1
/
gateways
/
{gateway_id}
/
auths
Error
A valid request URL is required to generate request examples{
"items": [
{
"api_key": "<string>",
"budget": {
"max": 123,
"time_window": "calendar_month",
"unit": "tokens"
},
"config": {
"mtls": {
"allowed_common_names": [
"<string>"
],
"allowed_dns_names": [
"<string>"
],
"allowed_fingerprints": [
"<string>"
],
"ca_cert": "<string>"
},
"oauth2": {
"allowed_algorithms": [
"<string>"
],
"audiences": [
"<string>"
],
"authorize_url": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"exchange_client_id": "<string>",
"exchange_client_secret": "<string>",
"introspection_url": "<string>",
"issuer": "<string>",
"jwks_url": "<string>",
"login_scopes": [
"<string>"
],
"public_keys": [
"<string>"
],
"required_scopes": [
"<string>"
],
"session_mode": true,
"subject_claim": "<string>",
"token_url": "<string>",
"userinfo_url": "<string>"
}
},
"consumers": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"type": "<string>"
}
],
"created_at": "<string>",
"enabled": true,
"expires_at": "<string>",
"gateway_id": "<string>",
"group_id": "<string>",
"group_name": "<string>",
"id": "<string>",
"key_prefix": "<string>",
"key_suffix": "<string>",
"name": "<string>",
"owner_email": "<string>",
"owner_groups": [
"<string>"
],
"owner_id": "<string>",
"type": "<string>",
"updated_at": "<string>"
}
],
"page": 123,
"size": 123,
"total": 123
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Path Parameters
Gateway id
Query Parameters
Substring match on name (alias: name)
Alias of search
Filter by auth type (api_key, oauth2, oidc, mtls)
Filter by enabled flag
List every key of this owner: their personal key and their group keys. Without it, personal keys are excluded
true lists only personal keys, of every owner; false lists only application keys, as when it is absent. Not allowed with owner_id (422 invalid_filter)
Sort field (name, created_at, updated_at, type)
Sort order (asc, desc)
Page number (1-based)
Page size
⌘I
Error
A valid request URL is required to generate request examples{
"items": [
{
"api_key": "<string>",
"budget": {
"max": 123,
"time_window": "calendar_month",
"unit": "tokens"
},
"config": {
"mtls": {
"allowed_common_names": [
"<string>"
],
"allowed_dns_names": [
"<string>"
],
"allowed_fingerprints": [
"<string>"
],
"ca_cert": "<string>"
},
"oauth2": {
"allowed_algorithms": [
"<string>"
],
"audiences": [
"<string>"
],
"authorize_url": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"exchange_client_id": "<string>",
"exchange_client_secret": "<string>",
"introspection_url": "<string>",
"issuer": "<string>",
"jwks_url": "<string>",
"login_scopes": [
"<string>"
],
"public_keys": [
"<string>"
],
"required_scopes": [
"<string>"
],
"session_mode": true,
"subject_claim": "<string>",
"token_url": "<string>",
"userinfo_url": "<string>"
}
},
"consumers": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"type": "<string>"
}
],
"created_at": "<string>",
"enabled": true,
"expires_at": "<string>",
"gateway_id": "<string>",
"group_id": "<string>",
"group_name": "<string>",
"id": "<string>",
"key_prefix": "<string>",
"key_suffix": "<string>",
"name": "<string>",
"owner_email": "<string>",
"owner_groups": [
"<string>"
],
"owner_id": "<string>",
"type": "<string>",
"updated_at": "<string>"
}
],
"page": 123,
"size": 123,
"total": 123
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}