RealtimeMessageAuthenticationToken¶
- class oci.ai_speech.models.RealtimeMessageAuthenticationToken(**kwargs)¶
Bases:
RealtimeMessageAuthenticationThe payload for JWT based authentication.
Attributes:
A constant which can be used with the authentication_type property of a RealtimeMessageAuthentication.
A constant which can be used with the authentication_type property of a RealtimeMessageAuthentication.
[Required] Gets the authentication_type of this RealtimeMessageAuthentication.
[Required] Gets the compartment_id of this RealtimeMessageAuthentication.
[Required] Gets the token of this RealtimeMessageAuthenticationToken.
Methods:
__init__(**kwargs)Initializes a new RealtimeMessageAuthenticationToken object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- AUTHENTICATION_TYPE_CREDENTIALS = 'CREDENTIALS'¶
A constant which can be used with the authentication_type property of a RealtimeMessageAuthentication. This constant has a value of “CREDENTIALS”
- AUTHENTICATION_TYPE_TOKEN = 'TOKEN'¶
A constant which can be used with the authentication_type property of a RealtimeMessageAuthentication. This constant has a value of “TOKEN”
- __init__(**kwargs)¶
Initializes a new RealtimeMessageAuthenticationToken object with values from keyword arguments. The default value of the
authentication_typeattribute of this class isTOKENand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
authentication_type (str) – The value to assign to the authentication_type property of this RealtimeMessageAuthenticationToken. Allowed values for this property are: “CREDENTIALS”, “TOKEN”
compartment_id (str) – The value to assign to the compartment_id property of this RealtimeMessageAuthenticationToken.
token (str) – The value to assign to the token property of this RealtimeMessageAuthenticationToken.
- property authentication_type¶
[Required] Gets the authentication_type of this RealtimeMessageAuthentication. Type of authentication method to be used.
Allowed values for this property are: “CREDENTIALS”, “TOKEN”
- Returns
The authentication_type of this RealtimeMessageAuthentication.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this RealtimeMessageAuthentication. Compartment ID to be used for authentication/authorization.
- Returns
The compartment_id of this RealtimeMessageAuthentication.
- Return type
str
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property token¶
[Required] Gets the token of this RealtimeMessageAuthenticationToken. The token (JWT) obtained from the realtime transcription session endpoint.
- Returns
The token of this RealtimeMessageAuthenticationToken.
- Return type
str