PrincipalDetails

class oci.devops.models.PrincipalDetails(**kwargs)

Bases: object

The principal details

Attributes:

PRINCIPAL_STATE_ACTIVE

A constant which can be used with the principal_state property of a PrincipalDetails.

PRINCIPAL_STATE_INACTIVE

A constant which can be used with the principal_state property of a PrincipalDetails.

PRINCIPAL_STATE_SUPPRESSED

A constant which can be used with the principal_state property of a PrincipalDetails.

PRINCIPAL_TYPE_INSTANCE

A constant which can be used with the principal_type property of a PrincipalDetails.

PRINCIPAL_TYPE_RESOURCE

A constant which can be used with the principal_type property of a PrincipalDetails.

PRINCIPAL_TYPE_SERVICE

A constant which can be used with the principal_type property of a PrincipalDetails.

PRINCIPAL_TYPE_USER

A constant which can be used with the principal_type property of a PrincipalDetails.

principal_id

[Required] Gets the principal_id of this PrincipalDetails.

principal_name

Gets the principal_name of this PrincipalDetails.

principal_state

Gets the principal_state of this PrincipalDetails.

principal_type

Gets the principal_type of this PrincipalDetails.

Methods:

__init__(**kwargs)

Initializes a new PrincipalDetails object with values from keyword arguments.

PRINCIPAL_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the principal_state property of a PrincipalDetails. This constant has a value of “ACTIVE”

PRINCIPAL_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the principal_state property of a PrincipalDetails. This constant has a value of “INACTIVE”

PRINCIPAL_STATE_SUPPRESSED = 'SUPPRESSED'

A constant which can be used with the principal_state property of a PrincipalDetails. This constant has a value of “SUPPRESSED”

PRINCIPAL_TYPE_INSTANCE = 'INSTANCE'

A constant which can be used with the principal_type property of a PrincipalDetails. This constant has a value of “INSTANCE”

PRINCIPAL_TYPE_RESOURCE = 'RESOURCE'

A constant which can be used with the principal_type property of a PrincipalDetails. This constant has a value of “RESOURCE”

PRINCIPAL_TYPE_SERVICE = 'SERVICE'

A constant which can be used with the principal_type property of a PrincipalDetails. This constant has a value of “SERVICE”

PRINCIPAL_TYPE_USER = 'USER'

A constant which can be used with the principal_type property of a PrincipalDetails. This constant has a value of “USER”

__init__(**kwargs)

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

Parameters
  • principal_id (str) – The value to assign to the principal_id property of this PrincipalDetails.

  • principal_name (str) – The value to assign to the principal_name property of this PrincipalDetails.

  • principal_type (str) – The value to assign to the principal_type property of this PrincipalDetails. Allowed values for this property are: “SERVICE”, “USER”, “INSTANCE”, “RESOURCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • principal_state (str) – The value to assign to the principal_state property of this PrincipalDetails. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “SUPPRESSED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property principal_id

[Required] Gets the principal_id of this PrincipalDetails. the OCID of the principal

Returns

The principal_id of this PrincipalDetails.

Return type

str

property principal_name

Gets the principal_name of this PrincipalDetails. the name of the principal

Returns

The principal_name of this PrincipalDetails.

Return type

str

property principal_state

Gets the principal_state of this PrincipalDetails. The state of the principal, it can be active or inactive or suppressed for emails

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

Returns

The principal_state of this PrincipalDetails.

Return type

str

property principal_type

Gets the principal_type of this PrincipalDetails. the type of principal

Allowed values for this property are: “SERVICE”, “USER”, “INSTANCE”, “RESOURCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The principal_type of this PrincipalDetails.

Return type

str