OAuth2ClientCredential¶

class oci.identity.models.OAuth2ClientCredential(**kwargs)¶

Bases: object

User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential.
`compartment_id`	Gets the compartment_id of this OAuth2ClientCredential.
`description`	Gets the description of this OAuth2ClientCredential.
`expires_on`	Gets the expires_on of this OAuth2ClientCredential.
`id`	Gets the id of this OAuth2ClientCredential.
`lifecycle_state`	Gets the lifecycle_state of this OAuth2ClientCredential.
`name`	Gets the name of this OAuth2ClientCredential.
`password`	Gets the password of this OAuth2ClientCredential.
`scopes`	Gets the scopes of this OAuth2ClientCredential.
`time_created`	Gets the time_created of this OAuth2ClientCredential.
`user_id`	Gets the user_id of this OAuth2ClientCredential.

Methods

__init__(**kwargs) Initializes a new OAuth2ClientCredential object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a OAuth2ClientCredential. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new OAuth2ClientCredential object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

scopes (list[oci.identity.models.FullyQualifiedScope]) – The value to assign to the scopes property of this OAuth2ClientCredential.
password (str) – The value to assign to the password property of this OAuth2ClientCredential.
user_id (str) – The value to assign to the user_id property of this OAuth2ClientCredential.
expires_on (datetime) – The value to assign to the expires_on property of this OAuth2ClientCredential.
id (str) – The value to assign to the id property of this OAuth2ClientCredential.
compartment_id (str) – The value to assign to the compartment_id property of this OAuth2ClientCredential.
name (str) – The value to assign to the name property of this OAuth2ClientCredential.
description (str) – The value to assign to the description property of this OAuth2ClientCredential.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OAuth2ClientCredential. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this OAuth2ClientCredential.

compartment_id¶

Gets the compartment_id of this OAuth2ClientCredential. The OCID of the compartment containing the Oauth credential.

Returns:	The compartment_id of this OAuth2ClientCredential.
Return type:	str

description¶

Gets the description of this OAuth2ClientCredential. The description of the Oauth credential.

Returns:	The description of this OAuth2ClientCredential.
Return type:	str

expires_on¶

Gets the expires_on of this OAuth2ClientCredential. Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires.

Example: 2016-08-25T21:10:29.600Z

Returns:	The expires_on of this OAuth2ClientCredential.
Return type:	datetime

id¶

Gets the id of this OAuth2ClientCredential. The OCID of the Oauth credential.

Returns:	The id of this OAuth2ClientCredential.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this OAuth2ClientCredential. The credential’s current state. After creating a Oauth credential, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this OAuth2ClientCredential.
Return type:	str

name¶

Gets the name of this OAuth2ClientCredential. The name of the Oauth credential.

Returns:	The name of this OAuth2ClientCredential.
Return type:	str

password¶

Gets the password of this OAuth2ClientCredential. Returned during create and update with password reset requests.

Returns:	The password of this OAuth2ClientCredential.
Return type:	str

scopes¶

Gets the scopes of this OAuth2ClientCredential. Allowed scopes for the given oauth credential.

Returns:	The scopes of this OAuth2ClientCredential.
Return type:	list[oci.identity.models.FullyQualifiedScope]

time_created¶

Gets the time_created of this OAuth2ClientCredential. Date and time the OAuth2ClientCredential object was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this OAuth2ClientCredential.
Return type:	datetime

user_id¶

Gets the user_id of this OAuth2ClientCredential. The OCID of the user the Oauth credential belongs to.

Returns:	The user_id of this OAuth2ClientCredential.
Return type:	str