Skip to content

Latest commit

 

History

History
66 lines (60 loc) · 4.52 KB

CreateAuthMethodGCP.md

File metadata and controls

66 lines (60 loc) · 4.52 KB

Akeyless::CreateAuthMethodGCP

Properties

Name Type Description Notes
access_expires Integer Access expiration date in Unix timestamp (select 0 for access without expiry date) [optional][default to 0]
allowed_client_type Array<String> limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension] [optional]
audience String The audience to verify in the JWT received by the client [default to 'akeyless.io']
audit_logs_claims Array<String> Subclaims to include in audit logs, e.g &quot;--audit-logs-claims email --audit-logs-claims username&quot; [optional]
bound_ips Array<String> A CIDR whitelist with the IPs that the access is restricted to [optional]
bound_labels Array<String> A comma-separated list of GCP labels formatted as &quot;key:value&quot; strings that must be set on authorized GCE instances. TODO: Because GCP labels are not currently ACL'd .... [optional]
bound_projects Array<String> === Human and Machine authentication section === Array of GCP project IDs. Only entities belonging to any of the provided projects can authenticate. [optional]
bound_regions Array<String> 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. [optional]
bound_service_accounts Array<String> List of service accounts the service account must be part of in order to be authenticated. [optional]
bound_zones Array<String> === 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. [optional]
delete_protection String Protection from accidental deletion of this object [true/false] [optional]
description String Auth Method description [optional]
expiration_event_in Array<String> How many days before the expiration of the auth method would you like to be notified. [optional]
force_sub_claims Boolean if true: enforce role-association must include sub claims [optional]
gw_bound_ips Array<String> A CIDR whitelist with the GW IPs that the access is restricted to [optional]
json Boolean Set output format to JSON [optional][default to false]
jwt_ttl Integer Jwt TTL [optional][default to 0]
name String Auth Method name
owner String Auth Method owner (free text, up to 255 characters). On update, omit to keep the current owner and pass an empty value to clear it [optional]
product_type Array<String> Choose the relevant product type for the auth method [sm, sra, pm, dp, ca, ara] [optional]
service_account_creds_data String ServiceAccount credentials data instead of giving a file path, base64 encoded [optional]
token String Authentication token (see `/auth` and `/configure`) [optional]
type String Type of the GCP Access Rules
uid_token String The universal identity token, Required only for universal_identity authentication [optional]
unique_identifier String A unique identifier (ID) value which is a &quot;sub claim&quot; name that contains details uniquely identifying that resource. This &quot;sub claim&quot; is used to distinguish between different identities. [optional]

Example

require 'akeyless'

instance = Akeyless::CreateAuthMethodGCP.new(
  access_expires: null,
  allowed_client_type: null,
  audience: null,
  audit_logs_claims: null,
  bound_ips: null,
  bound_labels: null,
  bound_projects: null,
  bound_regions: null,
  bound_service_accounts: null,
  bound_zones: null,
  delete_protection: null,
  description: null,
  expiration_event_in: null,
  force_sub_claims: null,
  gw_bound_ips: null,
  json: null,
  jwt_ttl: null,
  name: null,
  owner: null,
  product_type: null,
  service_account_creds_data: null,
  token: null,
  type: null,
  uid_token: null,
  unique_identifier: null
)