Skip to content

Latest commit

 

History

History
613 lines (330 loc) · 18.8 KB

CreateAuthMethodOAuth2.md

File metadata and controls

613 lines (330 loc) · 18.8 KB

CreateAuthMethodOAuth2

Properties

Name Type Description Notes
AccessExpires Pointer to int64 Access expiration date in Unix timestamp (select 0 for access without expiry date) [optional] [default to 0]
Audience Pointer to string The audience in the JWT [optional]
AuditLogsClaims Pointer to []string Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username" [optional]
BoundClientIds Pointer to []string The clients ids that the access is restricted to [optional]
BoundIps Pointer to []string A CIDR whitelist with the IPs that the access is restricted to [optional]
Cert Pointer to string CertificateFile Path to a file that contain the certificate in a PEM format. [optional]
CertFileData Pointer to string CertificateFileData PEM Certificate in a Base64 format. [optional]
DeleteProtection Pointer to string Protection from accidental deletion of this object [true/false] [optional]
Description Pointer to string Auth Method description [optional]
ForceSubClaims Pointer to bool if true: enforce role-association must include sub claims [optional]
GatewayUrl Pointer to string Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway. [optional]
GwBoundIps Pointer to []string A CIDR whitelist with the GW IPs that the access is restricted to [optional]
Issuer Pointer to string Issuer URL [optional]
Json Pointer to bool Set output format to JSON [optional] [default to false]
JwksJsonData Pointer to 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]
JwksUri 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. [default to "default_jwks_url"]
JwtTtl Pointer to int64 Jwt TTL [optional] [default to 0]
Name string Auth Method name
ProductType Pointer to []string Choose the relevant product type for the auth method [sm, sra, pm, dp, ca] [optional]
SubclaimsDelimiters Pointer to []string A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT) [optional]
Token Pointer to string Authentication token (see `/auth` and `/configure`) [optional]
UidToken Pointer to string The universal identity token, Required only for universal_identity authentication [optional]
UniqueIdentifier 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 "sub claim" 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.

Methods

NewCreateAuthMethodOAuth2

func NewCreateAuthMethodOAuth2(jwksUri string, name string, uniqueIdentifier string, ) *CreateAuthMethodOAuth2

NewCreateAuthMethodOAuth2 instantiates a new CreateAuthMethodOAuth2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewCreateAuthMethodOAuth2WithDefaults

func NewCreateAuthMethodOAuth2WithDefaults() *CreateAuthMethodOAuth2

NewCreateAuthMethodOAuth2WithDefaults instantiates a new CreateAuthMethodOAuth2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetAccessExpires

func (o *CreateAuthMethodOAuth2) GetAccessExpires() int64

GetAccessExpires returns the AccessExpires field if non-nil, zero value otherwise.

GetAccessExpiresOk

func (o *CreateAuthMethodOAuth2) GetAccessExpiresOk() (*int64, bool)

GetAccessExpiresOk returns a tuple with the AccessExpires field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAccessExpires

func (o *CreateAuthMethodOAuth2) SetAccessExpires(v int64)

SetAccessExpires sets AccessExpires field to given value.

HasAccessExpires

func (o *CreateAuthMethodOAuth2) HasAccessExpires() bool

HasAccessExpires returns a boolean if a field has been set.

GetAudience

func (o *CreateAuthMethodOAuth2) GetAudience() string

GetAudience returns the Audience field if non-nil, zero value otherwise.

GetAudienceOk

func (o *CreateAuthMethodOAuth2) GetAudienceOk() (*string, bool)

GetAudienceOk returns a tuple with the Audience field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAudience

func (o *CreateAuthMethodOAuth2) SetAudience(v string)

SetAudience sets Audience field to given value.

HasAudience

func (o *CreateAuthMethodOAuth2) HasAudience() bool

HasAudience returns a boolean if a field has been set.

GetAuditLogsClaims

func (o *CreateAuthMethodOAuth2) GetAuditLogsClaims() []string

GetAuditLogsClaims returns the AuditLogsClaims field if non-nil, zero value otherwise.

GetAuditLogsClaimsOk

func (o *CreateAuthMethodOAuth2) GetAuditLogsClaimsOk() (*[]string, bool)

GetAuditLogsClaimsOk returns a tuple with the AuditLogsClaims field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAuditLogsClaims

func (o *CreateAuthMethodOAuth2) SetAuditLogsClaims(v []string)

SetAuditLogsClaims sets AuditLogsClaims field to given value.

HasAuditLogsClaims

func (o *CreateAuthMethodOAuth2) HasAuditLogsClaims() bool

HasAuditLogsClaims returns a boolean if a field has been set.

GetBoundClientIds

func (o *CreateAuthMethodOAuth2) GetBoundClientIds() []string

GetBoundClientIds returns the BoundClientIds field if non-nil, zero value otherwise.

GetBoundClientIdsOk

func (o *CreateAuthMethodOAuth2) GetBoundClientIdsOk() (*[]string, bool)

GetBoundClientIdsOk returns a tuple with the BoundClientIds field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBoundClientIds

func (o *CreateAuthMethodOAuth2) SetBoundClientIds(v []string)

SetBoundClientIds sets BoundClientIds field to given value.

HasBoundClientIds

func (o *CreateAuthMethodOAuth2) HasBoundClientIds() bool

HasBoundClientIds returns a boolean if a field has been set.

GetBoundIps

func (o *CreateAuthMethodOAuth2) GetBoundIps() []string

GetBoundIps returns the BoundIps field if non-nil, zero value otherwise.

GetBoundIpsOk

func (o *CreateAuthMethodOAuth2) GetBoundIpsOk() (*[]string, bool)

GetBoundIpsOk returns a tuple with the BoundIps field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBoundIps

func (o *CreateAuthMethodOAuth2) SetBoundIps(v []string)

SetBoundIps sets BoundIps field to given value.

HasBoundIps

func (o *CreateAuthMethodOAuth2) HasBoundIps() bool

HasBoundIps returns a boolean if a field has been set.

GetCert

func (o *CreateAuthMethodOAuth2) GetCert() string

GetCert returns the Cert field if non-nil, zero value otherwise.

GetCertOk

func (o *CreateAuthMethodOAuth2) GetCertOk() (*string, bool)

GetCertOk returns a tuple with the Cert field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCert

func (o *CreateAuthMethodOAuth2) SetCert(v string)

SetCert sets Cert field to given value.

HasCert

func (o *CreateAuthMethodOAuth2) HasCert() bool

HasCert returns a boolean if a field has been set.

GetCertFileData

func (o *CreateAuthMethodOAuth2) GetCertFileData() string

GetCertFileData returns the CertFileData field if non-nil, zero value otherwise.

GetCertFileDataOk

func (o *CreateAuthMethodOAuth2) GetCertFileDataOk() (*string, bool)

GetCertFileDataOk returns a tuple with the CertFileData field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCertFileData

func (o *CreateAuthMethodOAuth2) SetCertFileData(v string)

SetCertFileData sets CertFileData field to given value.

HasCertFileData

func (o *CreateAuthMethodOAuth2) HasCertFileData() bool

HasCertFileData returns a boolean if a field has been set.

GetDeleteProtection

func (o *CreateAuthMethodOAuth2) GetDeleteProtection() string

GetDeleteProtection returns the DeleteProtection field if non-nil, zero value otherwise.

GetDeleteProtectionOk

func (o *CreateAuthMethodOAuth2) GetDeleteProtectionOk() (*string, bool)

GetDeleteProtectionOk returns a tuple with the DeleteProtection field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDeleteProtection

func (o *CreateAuthMethodOAuth2) SetDeleteProtection(v string)

SetDeleteProtection sets DeleteProtection field to given value.

HasDeleteProtection

func (o *CreateAuthMethodOAuth2) HasDeleteProtection() bool

HasDeleteProtection returns a boolean if a field has been set.

GetDescription

func (o *CreateAuthMethodOAuth2) GetDescription() string

GetDescription returns the Description field if non-nil, zero value otherwise.

GetDescriptionOk

func (o *CreateAuthMethodOAuth2) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDescription

func (o *CreateAuthMethodOAuth2) SetDescription(v string)

SetDescription sets Description field to given value.

HasDescription

func (o *CreateAuthMethodOAuth2) HasDescription() bool

HasDescription returns a boolean if a field has been set.

GetForceSubClaims

func (o *CreateAuthMethodOAuth2) GetForceSubClaims() bool

GetForceSubClaims returns the ForceSubClaims field if non-nil, zero value otherwise.

GetForceSubClaimsOk

func (o *CreateAuthMethodOAuth2) GetForceSubClaimsOk() (*bool, bool)

GetForceSubClaimsOk returns a tuple with the ForceSubClaims field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetForceSubClaims

func (o *CreateAuthMethodOAuth2) SetForceSubClaims(v bool)

SetForceSubClaims sets ForceSubClaims field to given value.

HasForceSubClaims

func (o *CreateAuthMethodOAuth2) HasForceSubClaims() bool

HasForceSubClaims returns a boolean if a field has been set.

GetGatewayUrl

func (o *CreateAuthMethodOAuth2) GetGatewayUrl() string

GetGatewayUrl returns the GatewayUrl field if non-nil, zero value otherwise.

GetGatewayUrlOk

func (o *CreateAuthMethodOAuth2) GetGatewayUrlOk() (*string, bool)

GetGatewayUrlOk returns a tuple with the GatewayUrl field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetGatewayUrl

func (o *CreateAuthMethodOAuth2) SetGatewayUrl(v string)

SetGatewayUrl sets GatewayUrl field to given value.

HasGatewayUrl

func (o *CreateAuthMethodOAuth2) HasGatewayUrl() bool

HasGatewayUrl returns a boolean if a field has been set.

GetGwBoundIps

func (o *CreateAuthMethodOAuth2) GetGwBoundIps() []string

GetGwBoundIps returns the GwBoundIps field if non-nil, zero value otherwise.

GetGwBoundIpsOk

func (o *CreateAuthMethodOAuth2) GetGwBoundIpsOk() (*[]string, bool)

GetGwBoundIpsOk returns a tuple with the GwBoundIps field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetGwBoundIps

func (o *CreateAuthMethodOAuth2) SetGwBoundIps(v []string)

SetGwBoundIps sets GwBoundIps field to given value.

HasGwBoundIps

func (o *CreateAuthMethodOAuth2) HasGwBoundIps() bool

HasGwBoundIps returns a boolean if a field has been set.

GetIssuer

func (o *CreateAuthMethodOAuth2) GetIssuer() string

GetIssuer returns the Issuer field if non-nil, zero value otherwise.

GetIssuerOk

func (o *CreateAuthMethodOAuth2) GetIssuerOk() (*string, bool)

GetIssuerOk returns a tuple with the Issuer field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIssuer

func (o *CreateAuthMethodOAuth2) SetIssuer(v string)

SetIssuer sets Issuer field to given value.

HasIssuer

func (o *CreateAuthMethodOAuth2) HasIssuer() bool

HasIssuer returns a boolean if a field has been set.

GetJson

func (o *CreateAuthMethodOAuth2) GetJson() bool

GetJson returns the Json field if non-nil, zero value otherwise.

GetJsonOk

func (o *CreateAuthMethodOAuth2) GetJsonOk() (*bool, bool)

GetJsonOk returns a tuple with the Json field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetJson

func (o *CreateAuthMethodOAuth2) SetJson(v bool)

SetJson sets Json field to given value.

HasJson

func (o *CreateAuthMethodOAuth2) HasJson() bool

HasJson returns a boolean if a field has been set.

GetJwksJsonData

func (o *CreateAuthMethodOAuth2) GetJwksJsonData() string

GetJwksJsonData returns the JwksJsonData field if non-nil, zero value otherwise.

GetJwksJsonDataOk

func (o *CreateAuthMethodOAuth2) GetJwksJsonDataOk() (*string, bool)

GetJwksJsonDataOk returns a tuple with the JwksJsonData field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetJwksJsonData

func (o *CreateAuthMethodOAuth2) SetJwksJsonData(v string)

SetJwksJsonData sets JwksJsonData field to given value.

HasJwksJsonData

func (o *CreateAuthMethodOAuth2) HasJwksJsonData() bool

HasJwksJsonData returns a boolean if a field has been set.

GetJwksUri

func (o *CreateAuthMethodOAuth2) GetJwksUri() string

GetJwksUri returns the JwksUri field if non-nil, zero value otherwise.

GetJwksUriOk

func (o *CreateAuthMethodOAuth2) GetJwksUriOk() (*string, bool)

GetJwksUriOk returns a tuple with the JwksUri field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetJwksUri

func (o *CreateAuthMethodOAuth2) SetJwksUri(v string)

SetJwksUri sets JwksUri field to given value.

GetJwtTtl

func (o *CreateAuthMethodOAuth2) GetJwtTtl() int64

GetJwtTtl returns the JwtTtl field if non-nil, zero value otherwise.

GetJwtTtlOk

func (o *CreateAuthMethodOAuth2) GetJwtTtlOk() (*int64, bool)

GetJwtTtlOk returns a tuple with the JwtTtl field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetJwtTtl

func (o *CreateAuthMethodOAuth2) SetJwtTtl(v int64)

SetJwtTtl sets JwtTtl field to given value.

HasJwtTtl

func (o *CreateAuthMethodOAuth2) HasJwtTtl() bool

HasJwtTtl returns a boolean if a field has been set.

GetName

func (o *CreateAuthMethodOAuth2) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *CreateAuthMethodOAuth2) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *CreateAuthMethodOAuth2) SetName(v string)

SetName sets Name field to given value.

GetProductType

func (o *CreateAuthMethodOAuth2) GetProductType() []string

GetProductType returns the ProductType field if non-nil, zero value otherwise.

GetProductTypeOk

func (o *CreateAuthMethodOAuth2) GetProductTypeOk() (*[]string, bool)

GetProductTypeOk returns a tuple with the ProductType field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProductType

func (o *CreateAuthMethodOAuth2) SetProductType(v []string)

SetProductType sets ProductType field to given value.

HasProductType

func (o *CreateAuthMethodOAuth2) HasProductType() bool

HasProductType returns a boolean if a field has been set.

GetSubclaimsDelimiters

func (o *CreateAuthMethodOAuth2) GetSubclaimsDelimiters() []string

GetSubclaimsDelimiters returns the SubclaimsDelimiters field if non-nil, zero value otherwise.

GetSubclaimsDelimitersOk

func (o *CreateAuthMethodOAuth2) GetSubclaimsDelimitersOk() (*[]string, bool)

GetSubclaimsDelimitersOk returns a tuple with the SubclaimsDelimiters field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSubclaimsDelimiters

func (o *CreateAuthMethodOAuth2) SetSubclaimsDelimiters(v []string)

SetSubclaimsDelimiters sets SubclaimsDelimiters field to given value.

HasSubclaimsDelimiters

func (o *CreateAuthMethodOAuth2) HasSubclaimsDelimiters() bool

HasSubclaimsDelimiters returns a boolean if a field has been set.

GetToken

func (o *CreateAuthMethodOAuth2) GetToken() string

GetToken returns the Token field if non-nil, zero value otherwise.

GetTokenOk

func (o *CreateAuthMethodOAuth2) GetTokenOk() (*string, bool)

GetTokenOk returns a tuple with the Token field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetToken

func (o *CreateAuthMethodOAuth2) SetToken(v string)

SetToken sets Token field to given value.

HasToken

func (o *CreateAuthMethodOAuth2) HasToken() bool

HasToken returns a boolean if a field has been set.

GetUidToken

func (o *CreateAuthMethodOAuth2) GetUidToken() string

GetUidToken returns the UidToken field if non-nil, zero value otherwise.

GetUidTokenOk

func (o *CreateAuthMethodOAuth2) GetUidTokenOk() (*string, bool)

GetUidTokenOk returns a tuple with the UidToken field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUidToken

func (o *CreateAuthMethodOAuth2) SetUidToken(v string)

SetUidToken sets UidToken field to given value.

HasUidToken

func (o *CreateAuthMethodOAuth2) HasUidToken() bool

HasUidToken returns a boolean if a field has been set.

GetUniqueIdentifier

func (o *CreateAuthMethodOAuth2) GetUniqueIdentifier() string

GetUniqueIdentifier returns the UniqueIdentifier field if non-nil, zero value otherwise.

GetUniqueIdentifierOk

func (o *CreateAuthMethodOAuth2) GetUniqueIdentifierOk() (*string, bool)

GetUniqueIdentifierOk returns a tuple with the UniqueIdentifier field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUniqueIdentifier

func (o *CreateAuthMethodOAuth2) SetUniqueIdentifier(v string)

SetUniqueIdentifier sets UniqueIdentifier field to given value.

[Back to Model list] [Back to API list] [Back to README]