AccessTokenInput

pydantic model openapi_client.models.access_token_input.AccessTokenInput

AccessTokenInput

Fields:
field name: StrictStr [Required] (alias 'Name')

Display name of the access token. Empty values rejected with IPV-1001 via check_body_values.

Constraints:

  • strict = True

field description: Optional[StrictStr] = None (alias 'Description')

Optional free-text description. If omitted during an update, the existing stored value is retained.

field expires_on: AccessTokenInputExpiresOn [Required] (alias 'ExpiresOn')
field role_id: StrictStr [Required] (alias 'RoleId')

Role ID bound into the JWT. Caller must have access (else AUTH-1003).

Constraints:

  • strict = True

field expiration_alert_one: StrictInt [Required] (alias 'ExpirationAlertOne')

Days before token expiry for the first reminder. Must be greater than ExpirationAlertTwo and greater than 1 and less than or equal to 14; otherwise, IPV-1036 or IPV-1012 is returned.

Constraints:

  • strict = True

field expiration_alert_two: StrictInt [Required] (alias 'ExpirationAlertTwo')

Days before token expiry for the second reminder. Must be less than ExpirationAlertOne and greater than or equal to 1 and less than 14; otherwise, IPV-1036 or IPV-1012 is returned.

Constraints:

  • strict = True

field custom_token_id: Optional[StrictStr] = None (alias 'CustomTokenId')

Optional custom TokenId. When omitted, a UUID is generated.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of AccessTokenInput from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of AccessTokenInput from a dict

Return type:

Optional[Self]