ResourcePrincipalAuthConfig

class oci.data_integration.models.ResourcePrincipalAuthConfig(**kwargs)

Bases: AuthConfig

Authentication configuration that uses OCI Resource Principal Auth for Generic REST invocation.

Attributes:

MODEL_TYPE_OCI_RESOURCE_AUTH_CONFIG

A constant which can be used with the model_type property of a AuthConfig.

RESOURCE_PRINCIPAL_SOURCE_APPLICATION

A constant which can be used with the resource_principal_source property of a ResourcePrincipalAuthConfig.

RESOURCE_PRINCIPAL_SOURCE_WORKSPACE

A constant which can be used with the resource_principal_source property of a ResourcePrincipalAuthConfig.

key

Gets the key of this AuthConfig.

model_type

Gets the model_type of this AuthConfig.

model_version

Gets the model_version of this AuthConfig.

parent_ref

Gets the parent_ref of this AuthConfig.

resource_principal_source

Gets the resource_principal_source of this ResourcePrincipalAuthConfig.

Methods:

__init__(**kwargs)

Initializes a new ResourcePrincipalAuthConfig 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.

MODEL_TYPE_OCI_RESOURCE_AUTH_CONFIG = 'OCI_RESOURCE_AUTH_CONFIG'

A constant which can be used with the model_type property of a AuthConfig. This constant has a value of “OCI_RESOURCE_AUTH_CONFIG”

RESOURCE_PRINCIPAL_SOURCE_APPLICATION = 'APPLICATION'

A constant which can be used with the resource_principal_source property of a ResourcePrincipalAuthConfig. This constant has a value of “APPLICATION”

RESOURCE_PRINCIPAL_SOURCE_WORKSPACE = 'WORKSPACE'

A constant which can be used with the resource_principal_source property of a ResourcePrincipalAuthConfig. This constant has a value of “WORKSPACE”

__init__(**kwargs)

Initializes a new ResourcePrincipalAuthConfig object with values from keyword arguments. The default value of the model_type attribute of this class is OCI_RESOURCE_AUTH_CONFIG and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • key (str) – The value to assign to the key property of this ResourcePrincipalAuthConfig.

  • model_version (str) – The value to assign to the model_version property of this ResourcePrincipalAuthConfig.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this ResourcePrincipalAuthConfig.

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

  • resource_principal_source (str) – The value to assign to the resource_principal_source property of this ResourcePrincipalAuthConfig. Allowed values for this property are: “WORKSPACE”, “APPLICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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 key

Gets the key of this AuthConfig. Generated key that can be used in API calls to identify this object.

Returns

The key of this AuthConfig.

Return type

str

property model_type

Gets the model_type of this AuthConfig. The specific authentication configuration to be used for Generic REST invocation.

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

Returns

The model_type of this AuthConfig.

Return type

str

property model_version

Gets the model_version of this AuthConfig. The model version of an object.

Returns

The model_version of this AuthConfig.

Return type

str

property parent_ref

Gets the parent_ref of this AuthConfig.

Returns

The parent_ref of this AuthConfig.

Return type

oci.data_integration.models.ParentReference

property resource_principal_source

Gets the resource_principal_source of this ResourcePrincipalAuthConfig. The OCI resource type that will supply the authentication token

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

Returns

The resource_principal_source of this ResourcePrincipalAuthConfig.

Return type

str