v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/gateway-update-allowed-access

Request body

SubClaimsCaseInsensitiveboolean
access-idstring required

Access ID The access id to be attached to this allowed access. Auth method with this access id should already exist.

case-sensitivestring

Treat sub claims as case-sensitive [true/false]

descriptionstring

Allowed access description

jsonboolean

Set output format to JSON

namestring required

Allowed access name

new-namestring

New allowed access name

permissionsstring

Permissions

Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classic_keys,automatic_migration,ldap_auth,dynamic_secret,k8s_auth,log_forwarding,zero_knowledge_encryption,rotated_secret,caching,event_forwarding,admin,kmip,general,rotate_secret_value]

sub-claimsobject

Sub claims key/val of sub claims, e.g group=admins,developers

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

Response

gatewayCreateAllowedAccessResponse wraps response body.

access_idstring
access_typestring
cluster_idinteger
created_atstring date-time
descriptionstring
editableboolean
errorstring
idinteger
is_validboolean
namestring
permissionsAccessPermission[]
sub_claimsobject
sub_claims_case_insensitiveboolean
updated_atstring date-time