Name | Type | Description | Notes |
---|---|---|---|
GrantType | GrantType | ||
ClientId | int64 | The ID of the client application which will be associated with a newly created access token. | |
Subject | Pointer to string | The subject (= unique identifier) of the user who will be associated with a newly created access token. This parameter is required unless the grant type is `CLIENT_CREDENTIALS`. The value must consist of only ASCII characters and its length must not exceed 100. | [optional] |
Scopes | Pointer to []string | The scopes which will be associated with a newly created access token. Scopes that are not supported by the service cannot be specified and requesting them will cause an error. | [optional] |
AccessTokenDuration | Pointer to int64 | The duration of a newly created access token in seconds. If the value is 0, the duration is determined according to the settings of the service. | [optional] |
RefreshTokenDuration | Pointer to int64 | The duration of a newly created refresh token in seconds. If the value is 0, the duration is determined according to the settings of the service. A refresh token is not created (1) if the service does not support `REFRESH_TOKEN`, or (2) if the specified grant type is either `IMPLICIT`or `CLIENT_CREDENTIALS`. | [optional] |
Properties | Pointer to []Property | Extra properties to associate with a newly created access token. Note that properties parameter is accepted only when the HTTP method of the request is POST and Content-Type of the request is `application/json`, so don't use `GET` method or `application/x-www-form-urlencoded` if you want to specify properties. | [optional] |
ClientIdAliasUsed | Pointer to bool | A boolean request parameter which indicates whether to emulate that the client ID alias is used instead of the original numeric client ID when a new access token is created. This has an effect only on the value of the aud claim in a response from UserInfo endpoint. When you access the UserInfo endpoint (which is expected to be implemented using Authlete's `/api/auth/userinfo` API and `/api/auth/userinfo/issue` API) with an access token which has been created using Authlete's `/api/auth/token/create` API with this property (`clientIdAliasUsed`) `true`, the client ID alias is used as the value of the aud claim in a response from the UserInfo endpoint. Note that if a client ID alias is not assigned to the client when Authlete's `/api/auth/token/create` API is called, this property (`clientIdAliasUsed`) has no effect (it is always regarded as `false`). | [optional] |
AccessToken | Pointer to string | The value of the new access token. The `/api/auth/token/create` API generates an access token. Therefore, callers of the API do not have to specify values of newly created access tokens. However, in some cases, for example, if you want to migrate existing access tokens from an old system to Authlete, you may want to specify values of access tokens. In such a case, you can specify the value of a newly created access token by passing a non-null value as the value of accessToken request parameter. The implementation of the `/api/auth/token/create` uses the value of the accessToken request parameter instead of generating a new value when the request parameter holds a non-null value. Note that if the hash value of the specified access token already exists in Authlete's database, the access token cannot be inserted and the `/api/auth/token/create` API will report an error. | [optional] |
RefreshToken | Pointer to string | The value of the new refresh token. The `/api/auth/token/create` API may generate a refresh token. Therefore, callers of the API do not have to specify values of newly created refresh tokens. However, in some cases, for example, if you want to migrate existing refresh tokens from an old system to Authlete, you may want to specify values of refresh tokens. In such a case, you can specify the value of a newly created refresh token by passing a non-null value as the value of refreshToken request parameter. The implementation of the `/api/auth/token/create` uses the value of the refreshToken request parameter instead of generating a new value when the request parameter holds a non-null value. Note that if the hash value of the specified refresh token already exists in Authlete's database, the refresh token cannot be inserted and the `/api/auth/token/create` API will report an error. | [optional] |
AccessTokenPersistent | Pointer to bool | Get whether the access token expires or not. By default, all access tokens expire after a period of time determined by their service. If this request parameter is `true`, then the access token will not automatically expire and must be revoked or deleted manually at the service. If this request parameter is true, the `accessTokenDuration` request parameter is ignored. | [optional] |
CertificateThumbprint | Pointer to string | The thumbprint of the MTLS certificate bound to this token. If this property is set, a certificate with the corresponding value MUST be presented with the access token when it is used by a client. The value of this property must be a SHA256 certificate thumbprint, base64url encoded. | [optional] |
DpopKeyThumbprint | Pointer to string | The thumbprint of the public key used for DPoP presentation of this token. If this property is set, a DPoP proof signed with the corresponding private key MUST be presented with the access token when it is used by a client. Additionally, the token's `token_type` will be set to 'DPoP'. | [optional] |
AuthorizationDetails | Pointer to AuthzDetails | [optional] | |
Resources | Pointer to []string | The value of the resources to associate with the token. This property represents the value of one or more `resource` request parameters which is defined in "RFC8707 Resource Indicators for OAuth 2.0". | [optional] |
ForExternalAttachment | Pointer to bool | the flag which indicates whether the access token is for an external attachment. | [optional] |
JwtAtClaims | Pointer to string | Additional claims that are added to the payload part of the JWT access token. | [optional] |
Acr | Pointer to string | The Authentication Context Class Reference of the user authentication that the authorization server performed during the course of issuing the access token. | [optional] |
AuthTime | Pointer to int64 | The time when the user authentication was performed during the course of issuing the access token. | [optional] |
ClientEntityIdUsed | Pointer to bool | Flag which indicates whether the entity ID of the client was used when the request for the access token was made. | [optional] |
func NewTokenCreateRequest(grantType GrantType, clientId int64, ) *TokenCreateRequest
NewTokenCreateRequest instantiates a new TokenCreateRequest 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
func NewTokenCreateRequestWithDefaults() *TokenCreateRequest
NewTokenCreateRequestWithDefaults instantiates a new TokenCreateRequest 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
func (o *TokenCreateRequest) GetGrantType() GrantType
GetGrantType returns the GrantType field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetGrantTypeOk() (*GrantType, bool)
GetGrantTypeOk returns a tuple with the GrantType field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetGrantType(v GrantType)
SetGrantType sets GrantType field to given value.
func (o *TokenCreateRequest) GetClientId() int64
GetClientId returns the ClientId field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetClientIdOk() (*int64, bool)
GetClientIdOk returns a tuple with the ClientId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetClientId(v int64)
SetClientId sets ClientId field to given value.
func (o *TokenCreateRequest) GetSubject() string
GetSubject returns the Subject field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetSubjectOk() (*string, bool)
GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetSubject(v string)
SetSubject sets Subject field to given value.
func (o *TokenCreateRequest) HasSubject() bool
HasSubject returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetScopes() []string
GetScopes returns the Scopes field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetScopesOk() (*[]string, bool)
GetScopesOk returns a tuple with the Scopes field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetScopes(v []string)
SetScopes sets Scopes field to given value.
func (o *TokenCreateRequest) HasScopes() bool
HasScopes returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetAccessTokenDuration() int64
GetAccessTokenDuration returns the AccessTokenDuration field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetAccessTokenDurationOk() (*int64, bool)
GetAccessTokenDurationOk returns a tuple with the AccessTokenDuration field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetAccessTokenDuration(v int64)
SetAccessTokenDuration sets AccessTokenDuration field to given value.
func (o *TokenCreateRequest) HasAccessTokenDuration() bool
HasAccessTokenDuration returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetRefreshTokenDuration() int64
GetRefreshTokenDuration returns the RefreshTokenDuration field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetRefreshTokenDurationOk() (*int64, bool)
GetRefreshTokenDurationOk returns a tuple with the RefreshTokenDuration field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetRefreshTokenDuration(v int64)
SetRefreshTokenDuration sets RefreshTokenDuration field to given value.
func (o *TokenCreateRequest) HasRefreshTokenDuration() bool
HasRefreshTokenDuration returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetProperties() []Property
GetProperties returns the Properties field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetPropertiesOk() (*[]Property, bool)
GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetProperties(v []Property)
SetProperties sets Properties field to given value.
func (o *TokenCreateRequest) HasProperties() bool
HasProperties returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetClientIdAliasUsed() bool
GetClientIdAliasUsed returns the ClientIdAliasUsed field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetClientIdAliasUsedOk() (*bool, bool)
GetClientIdAliasUsedOk returns a tuple with the ClientIdAliasUsed field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetClientIdAliasUsed(v bool)
SetClientIdAliasUsed sets ClientIdAliasUsed field to given value.
func (o *TokenCreateRequest) HasClientIdAliasUsed() bool
HasClientIdAliasUsed returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetAccessToken() string
GetAccessToken returns the AccessToken field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetAccessTokenOk() (*string, bool)
GetAccessTokenOk returns a tuple with the AccessToken field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetAccessToken(v string)
SetAccessToken sets AccessToken field to given value.
func (o *TokenCreateRequest) HasAccessToken() bool
HasAccessToken returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetRefreshToken() string
GetRefreshToken returns the RefreshToken field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetRefreshTokenOk() (*string, bool)
GetRefreshTokenOk returns a tuple with the RefreshToken field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetRefreshToken(v string)
SetRefreshToken sets RefreshToken field to given value.
func (o *TokenCreateRequest) HasRefreshToken() bool
HasRefreshToken returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetAccessTokenPersistent() bool
GetAccessTokenPersistent returns the AccessTokenPersistent field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetAccessTokenPersistentOk() (*bool, bool)
GetAccessTokenPersistentOk returns a tuple with the AccessTokenPersistent field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetAccessTokenPersistent(v bool)
SetAccessTokenPersistent sets AccessTokenPersistent field to given value.
func (o *TokenCreateRequest) HasAccessTokenPersistent() bool
HasAccessTokenPersistent returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetCertificateThumbprint() string
GetCertificateThumbprint returns the CertificateThumbprint field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetCertificateThumbprintOk() (*string, bool)
GetCertificateThumbprintOk returns a tuple with the CertificateThumbprint field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetCertificateThumbprint(v string)
SetCertificateThumbprint sets CertificateThumbprint field to given value.
func (o *TokenCreateRequest) HasCertificateThumbprint() bool
HasCertificateThumbprint returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetDpopKeyThumbprint() string
GetDpopKeyThumbprint returns the DpopKeyThumbprint field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetDpopKeyThumbprintOk() (*string, bool)
GetDpopKeyThumbprintOk returns a tuple with the DpopKeyThumbprint field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetDpopKeyThumbprint(v string)
SetDpopKeyThumbprint sets DpopKeyThumbprint field to given value.
func (o *TokenCreateRequest) HasDpopKeyThumbprint() bool
HasDpopKeyThumbprint returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetAuthorizationDetails() AuthzDetails
GetAuthorizationDetails returns the AuthorizationDetails field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetAuthorizationDetailsOk() (*AuthzDetails, bool)
GetAuthorizationDetailsOk returns a tuple with the AuthorizationDetails field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetAuthorizationDetails(v AuthzDetails)
SetAuthorizationDetails sets AuthorizationDetails field to given value.
func (o *TokenCreateRequest) HasAuthorizationDetails() bool
HasAuthorizationDetails returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetResources() []string
GetResources returns the Resources field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetResourcesOk() (*[]string, bool)
GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetResources(v []string)
SetResources sets Resources field to given value.
func (o *TokenCreateRequest) HasResources() bool
HasResources returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetForExternalAttachment() bool
GetForExternalAttachment returns the ForExternalAttachment field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetForExternalAttachmentOk() (*bool, bool)
GetForExternalAttachmentOk returns a tuple with the ForExternalAttachment field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetForExternalAttachment(v bool)
SetForExternalAttachment sets ForExternalAttachment field to given value.
func (o *TokenCreateRequest) HasForExternalAttachment() bool
HasForExternalAttachment returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetJwtAtClaims() string
GetJwtAtClaims returns the JwtAtClaims field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetJwtAtClaimsOk() (*string, bool)
GetJwtAtClaimsOk returns a tuple with the JwtAtClaims field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetJwtAtClaims(v string)
SetJwtAtClaims sets JwtAtClaims field to given value.
func (o *TokenCreateRequest) HasJwtAtClaims() bool
HasJwtAtClaims returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetAcr() string
GetAcr returns the Acr field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetAcrOk() (*string, bool)
GetAcrOk returns a tuple with the Acr field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetAcr(v string)
SetAcr sets Acr field to given value.
func (o *TokenCreateRequest) HasAcr() bool
HasAcr returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetAuthTime() int64
GetAuthTime returns the AuthTime field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetAuthTimeOk() (*int64, bool)
GetAuthTimeOk returns a tuple with the AuthTime field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetAuthTime(v int64)
SetAuthTime sets AuthTime field to given value.
func (o *TokenCreateRequest) HasAuthTime() bool
HasAuthTime returns a boolean if a field has been set.
func (o *TokenCreateRequest) GetClientEntityIdUsed() bool
GetClientEntityIdUsed returns the ClientEntityIdUsed field if non-nil, zero value otherwise.
func (o *TokenCreateRequest) GetClientEntityIdUsedOk() (*bool, bool)
GetClientEntityIdUsedOk returns a tuple with the ClientEntityIdUsed field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *TokenCreateRequest) SetClientEntityIdUsed(v bool)
SetClientEntityIdUsed sets ClientEntityIdUsed field to given value.
func (o *TokenCreateRequest) HasClientEntityIdUsed() bool
HasClientEntityIdUsed returns a boolean if a field has been set.