Skip to content

Latest commit

 

History

History
1320 lines (844 loc) · 52.7 KB

dataOktaAppOauth.python.md

File metadata and controls

1320 lines (844 loc) · 52.7 KB
Raw

dataOktaAppOauth Submodule

Constructs

DataOktaAppOauth

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth okta_app_oauth}.

Initializers 

from cdktf_cdktf_provider_okta import data_okta_app_oauth

dataOktaAppOauth.DataOktaAppOauth(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  active_only: typing.Union[bool, IResolvable] = None,
  id: str = None,
  label: str = None,
  label_prefix: str = None,
  skip_groups: typing.Union[bool, IResolvable] = None,
  skip_users: typing.Union[bool, IResolvable] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
active_only typing.Union[bool, cdktf.IResolvable] Search only ACTIVE applications.
id str Id of application to retrieve, conflicts with label and label_prefix.
label str The label of the app to retrieve, conflicts with label_prefix and id.
label_prefix str Label prefix of the app to retrieve, conflicts with label and id.
skip_groups typing.Union[bool, cdktf.IResolvable] Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources.
skip_users typing.Union[bool, cdktf.IResolvable] Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
active_onlyOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Search only ACTIVE applications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#active_only DataOktaAppOauth#active_only}

idOptional
  • Type: str

Id of application to retrieve, conflicts with label and label_prefix.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#id DataOktaAppOauth#id}

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

labelOptional
  • Type: str

The label of the app to retrieve, conflicts with label_prefix and id.

Label uses the ?q= query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#label DataOktaAppOauth#label}

label_prefixOptional
  • Type: str

Label prefix of the app to retrieve, conflicts with label and id.

This will tell the provider to do a starts with query as opposed to an equals query.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#label_prefix DataOktaAppOauth#label_prefix}

skip_groupsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#skip_groups DataOktaAppOauth#skip_groups}

skip_usersOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#skip_users DataOktaAppOauth#skip_users}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform Adds this resource to the terraform JSON output.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
reset_active_only No description.
reset_id No description.
reset_label No description.
reset_label_prefix No description.
reset_skip_groups No description.
reset_skip_users No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
reset_active_only 
def reset_active_only() -> None
reset_id 
def reset_id() -> None
reset_label 
def reset_label() -> None
reset_label_prefix 
def reset_label_prefix() -> None
reset_skip_groups 
def reset_skip_groups() -> None
reset_skip_users 
def reset_skip_users() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_data_source No description.
generate_config_for_import Generates CDKTF code for importing a DataOktaAppOauth resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_okta import data_okta_app_oauth

dataOktaAppOauth.DataOktaAppOauth.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_okta import data_okta_app_oauth

dataOktaAppOauth.DataOktaAppOauth.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_data_source 
from cdktf_cdktf_provider_okta import data_okta_app_oauth

dataOktaAppOauth.DataOktaAppOauth.is_terraform_data_source(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_okta import data_okta_app_oauth

dataOktaAppOauth.DataOktaAppOauth.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a DataOktaAppOauth resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the DataOktaAppOauth to import.

import_from_idRequired
  • Type: str

The id of the existing DataOktaAppOauth that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataOktaAppOauth to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
auto_submit_toolbar cdktf.IResolvable No description.
client_id str No description.
client_secret str No description.
client_uri str No description.
grant_types typing.List[str] No description.
hide_ios cdktf.IResolvable No description.
hide_web cdktf.IResolvable No description.
links str No description.
login_mode str No description.
login_scopes typing.List[str] No description.
login_uri str No description.
logo_uri str No description.
name str No description.
policy_uri str No description.
post_logout_redirect_uris typing.List[str] No description.
redirect_uris typing.List[str] No description.
response_types typing.List[str] No description.
status str No description.
type str No description.
wildcard_redirect str No description.
active_only_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
label_input str No description.
label_prefix_input str No description.
skip_groups_input typing.Union[bool, cdktf.IResolvable] No description.
skip_users_input typing.Union[bool, cdktf.IResolvable] No description.
active_only typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
label str No description.
label_prefix str No description.
skip_groups typing.Union[bool, cdktf.IResolvable] No description.
skip_users typing.Union[bool, cdktf.IResolvable] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
auto_submit_toolbarRequired 
auto_submit_toolbar: IResolvable
  • Type: cdktf.IResolvable
client_idRequired 
client_id: str
  • Type: str
client_secretRequired 
client_secret: str
  • Type: str
client_uriRequired 
client_uri: str
  • Type: str
grant_typesRequired 
grant_types: typing.List[str]
  • Type: typing.List[str]
hide_iosRequired 
hide_ios: IResolvable
  • Type: cdktf.IResolvable
hide_webRequired 
hide_web: IResolvable
  • Type: cdktf.IResolvable
linksRequired 
links: str
  • Type: str
login_modeRequired 
login_mode: str
  • Type: str
login_scopesRequired 
login_scopes: typing.List[str]
  • Type: typing.List[str]
login_uriRequired 
login_uri: str
  • Type: str
logo_uriRequired 
logo_uri: str
  • Type: str
nameRequired 
name: str
  • Type: str
policy_uriRequired 
policy_uri: str
  • Type: str
post_logout_redirect_urisRequired 
post_logout_redirect_uris: typing.List[str]
  • Type: typing.List[str]
redirect_urisRequired 
redirect_uris: typing.List[str]
  • Type: typing.List[str]
response_typesRequired 
response_types: typing.List[str]
  • Type: typing.List[str]
statusRequired 
status: str
  • Type: str
typeRequired 
type: str
  • Type: str
wildcard_redirectRequired 
wildcard_redirect: str
  • Type: str
active_only_inputOptional 
active_only_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
label_inputOptional 
label_input: str
  • Type: str
label_prefix_inputOptional 
label_prefix_input: str
  • Type: str
skip_groups_inputOptional 
skip_groups_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
skip_users_inputOptional 
skip_users_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
active_onlyRequired 
active_only: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
labelRequired 
label: str
  • Type: str
label_prefixRequired 
label_prefix: str
  • Type: str
skip_groupsRequired 
skip_groups: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
skip_usersRequired 
skip_users: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

DataOktaAppOauthConfig

Initializer 

from cdktf_cdktf_provider_okta import data_okta_app_oauth

dataOktaAppOauth.DataOktaAppOauthConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  active_only: typing.Union[bool, IResolvable] = None,
  id: str = None,
  label: str = None,
  label_prefix: str = None,
  skip_groups: typing.Union[bool, IResolvable] = None,
  skip_users: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
active_only typing.Union[bool, cdktf.IResolvable] Search only ACTIVE applications.
id str Id of application to retrieve, conflicts with label and label_prefix.
label str The label of the app to retrieve, conflicts with label_prefix and id.
label_prefix str Label prefix of the app to retrieve, conflicts with label and id.
skip_groups typing.Union[bool, cdktf.IResolvable] Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources.
skip_users typing.Union[bool, cdktf.IResolvable] Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
active_onlyOptional 
active_only: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Search only ACTIVE applications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#active_only DataOktaAppOauth#active_only}

idOptional 
id: str
  • Type: str

Id of application to retrieve, conflicts with label and label_prefix.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#id DataOktaAppOauth#id}

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

labelOptional 
label: str
  • Type: str

The label of the app to retrieve, conflicts with label_prefix and id.

Label uses the ?q= query parameter exposed by Okta's List Apps API. The API will search both name and label using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#label DataOktaAppOauth#label}

label_prefixOptional 
label_prefix: str
  • Type: str

Label prefix of the app to retrieve, conflicts with label and id.

This will tell the provider to do a starts with query as opposed to an equals query.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#label_prefix DataOktaAppOauth#label_prefix}

skip_groupsOptional 
skip_groups: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Ignore groups sync. This is a temporary solution until 'groups' field is supported in all the app-like resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#skip_groups DataOktaAppOauth#skip_groups}

skip_usersOptional 
skip_users: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Ignore users sync. This is a temporary solution until 'users' field is supported in all the app-like resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/data-sources/app_oauth#skip_users DataOktaAppOauth#skip_users}