/auth-method-update-gcp

post

https://api.akeyless.io/auth-method-update-gcp

Body Params

access-expires

int64

Defaults to 0

Access expiration date in Unix timestamp (select 0 for access without expiry date)

allowed-client-type

array of strings

limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]

allowed-client-type

audience

string

required

Defaults to akeyless.io

The audience to verify in the JWT received by the client

audit-logs-claims

array of strings

Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"

audit-logs-claims

bound-ips

array of strings

A CIDR whitelist with the IPs that the access is restricted to

bound-ips

bound-labels

array of strings

A comma-separated list of GCP labels formatted as "key:value" strings that must be set on authorized GCE instances. TODO: Because GCP labels are not currently ACL'd ....

bound-labels

bound-projects

array of strings

=== Human and Machine authentication section === Array of GCP project IDs. Only entities belonging to any of the provided projects can authenticate.

bound-projects

bound-regions

array of strings

List of regions that a GCE instance must belong to in order to be authenticated. TODO: If bound_instance_groups is provided, it is assumed to be a regional group and the group must belong to this region. If bound_zones are provided, this attribute is ignored.

bound-regions

bound-service-accounts

array of strings

List of service accounts the service account must be part of in order to be authenticated.

bound-service-accounts

bound-zones

array of strings

=== Machine authentication section === List of zones that a GCE instance must belong to in order to be authenticated. TODO: If bound_instance_groups is provided, it is assumed to be a zonal group and the group must belong to this zone.

bound-zones

delete_protection

string

Protection from accidental deletion of this object [true/false]

description

string

Auth Method description

expiration-event-in

array of strings

How many days before the expiration of the auth method would you like to be notified.

expiration-event-in

force-sub-claims

boolean

if true: enforce role-association must include sub claims

gw-bound-ips

array of strings

A CIDR whitelist with the GW IPs that the access is restricted to

gw-bound-ips

json

boolean

Defaults to false

Set output format to JSON

jwt-ttl

int64

Defaults to 0

Jwt TTL

name

string

required

Auth Method name

new-name

string

Auth Method new name

product-type

array of strings

Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]

product-type

service-account-creds-data

string

ServiceAccount credentials data instead of giving a file path, base64 encoded

token

string

Authentication token (see /auth and /configure)

type

string

required

Type of the GCP Access Rules

uid-token

string

The universal identity token, Required only for universal_identity authentication

unique-identifier

string

A unique identifier (ID) value which is a "sub claim" name that contains details uniquely identifying that resource. This "sub claim" is used to distinguish between different identities.

Responses

201authMethodUpdateGcpResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.