Skip to content

CreateAuthMethodOAuth2.md

Latest commit

 

History

History
66 lines (60 loc) · 4.2 KB

CreateAuthMethodOAuth2.md

File metadata and controls

66 lines (60 loc) · 4.2 KB

Akeyless::CreateAuthMethodOAuth2

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 in the JWT [optional]
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_client_ids Array<String> The clients ids that the access is restricted to [optional]
bound_ips Array<String> A CIDR whitelist with the IPs that the access is restricted to [optional]
cert String CertificateFile Path to a file that contain the certificate in a PEM format. [optional]
cert_file_data String CertificateFileData PEM Certificate in a Base64 format. [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]
gateway_url String Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway. [optional]
gw_bound_ips Array<String> A CIDR whitelist with the GW IPs that the access is restricted to [optional]
issuer String Issuer URL [optional]
json Boolean Set output format to JSON [optional][default to false]
jwks_json_data String The JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server. base64 encoded string [optional]
jwks_uri String The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server. [optional]
jwt_ttl Integer Jwt TTL [optional][default to 0]
name String Auth Method name
product_type Array<String> Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] [optional]
subclaims_delimiters Array<String> A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT) [optional]
token String Authentication token (see `/auth` and `/configure`) [optional]
uid_token String The universal identity token, Required only for universal_identity authentication [optional]
unique_identifier String A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a &quot;sub claim&quot; that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.

Example

require 'akeyless'

instance = Akeyless::CreateAuthMethodOAuth2.new(
  access_expires: null,
  allowed_client_type: null,
  audience: null,
  audit_logs_claims: null,
  bound_client_ids: null,
  bound_ips: null,
  cert: null,
  cert_file_data: null,
  delete_protection: null,
  description: null,
  expiration_event_in: null,
  force_sub_claims: null,
  gateway_url: null,
  gw_bound_ips: null,
  issuer: null,
  json: null,
  jwks_json_data: null,
  jwks_uri: null,
  jwt_ttl: null,
  name: null,
  product_type: null,
  subclaims_delimiters: null,
  token: null,
  uid_token: null,
  unique_identifier: null
)