Skip to content

ApplicationProps

Properties for defining a Application.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ram-application

Initializer 

import ros_cdk_ram
ros_cdk_ram.ApplicationProps(
  app_name: typing.Union[str, IResolvable],
  app_type: typing.Union[str, IResolvable],
  display_name: typing.Union[str, IResolvable],
  access_token_validity: typing.Union[typing.Union[int, float], IResolvable] = None,
  is_multi_tenant: typing.Union[bool, IResolvable] = None,
  predefined_scopes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  redirect_uris: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  refresh_token_validity: typing.Union[typing.Union[int, float], IResolvable] = None,
  required_scopes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  secret_required: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
app_name typing.Union[str, ros_cdk_core.IResolvable] Property appName: The name of the application.
app_type typing.Union[str, ros_cdk_core.IResolvable] Property appType: The type of the application.
display_name typing.Union[str, ros_cdk_core.IResolvable] Property displayName: The display name of the application.
access_token_validity typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property accessTokenValidity: The validity period of the access token.
is_multi_tenant typing.Union[bool, ros_cdk_core.IResolvable] Property isMultiTenant: Indicates whether the application can be installed by using other Alibaba Cloud accounts.
predefined_scopes typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property predefinedScopes: List of the scopes of application permissions.
redirect_uris typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property redirectUris: List of the callback URLs.
refresh_token_validity typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property refreshTokenValidity: The validity period of the refreshed token.
required_scopes typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property requiredScopes: Required scope of application permissions.
secret_required typing.Union[bool, ros_cdk_core.IResolvable] Property secretRequired: Indicates whether a secret is required.

app_nameRequired 

app_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property appName: The name of the application.

The name can be up to 64 characters in length. The name can contain letters, digits, periods (.), underscores (_), and hyphens (-).

app_typeRequired 

app_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property appType: The type of the application.

Valid values:

  • WebApp: a web application that interacts with a browser.
  • NativeApp: a native application that runs on an operating system, such as a desktop operating system or a mobile operating system.
  • ServerApp: an application that accesses Alibaba Cloud services without the need of manual user logon. User provisioning is automated based on the System for Cross-Domain Identity Management (SCIM) protocol.

display_nameRequired 

display_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property displayName: The display name of the application.

The name can be up to 24 characters in length.

access_token_validityOptional 

access_token_validity: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property accessTokenValidity: The validity period of the access token.

Valid values: 900 to 10800. Unit: seconds. Default value: 3600.

is_multi_tenantOptional 

is_multi_tenant: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property isMultiTenant: Indicates whether the application can be installed by using other Alibaba Cloud accounts.

Valid values:

  • true: If you do not set this parameter for applications of the NativeApp and ServerApp types, true is used.
  • false: If you do not set this parameter for applications of the WebApp type, false is used.

predefined_scopesOptional 

predefined_scopes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property predefinedScopes: List of the scopes of application permissions.

redirect_urisOptional 

redirect_uris: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property redirectUris: List of the callback URLs.

refresh_token_validityOptional 

refresh_token_validity: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property refreshTokenValidity: The validity period of the refreshed token.

Valid values: 7200 to 31536000. Unit: seconds. Default value:

  • For applications of the WebApp and ServerApp types, if this parameter is left empty, the value 2592000 is used. The value 2592000 indicates that the validity period of the refreshed token is 30 days.
  • For applications of the NativeApp type, if this parameter is left empty, the value 7776000 is used. The value 7776000 indicates that the validity period of the refreshed token is 90 days.

required_scopesOptional 

required_scopes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property requiredScopes: Required scope of application permissions.

You can set one or more of the scopes set in the PredefinedScopes to be required, so that when a user authorizes the application, the required scopes are selected by default and cannot be canceled. Notes: If you set a RequiredScopes entry that is not within the scope of PredefinedScopes, the required range will not take effect.

secret_requiredOptional 

secret_required: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property secretRequired: Indicates whether a secret is required.

Valid values: true and false. Note:

  • For applications of the WebApp and ServerApp types, this parameter is automatically set to true and cannot be changed.
  • For applications of the NativeApp type, this parameter can be set to true or false. If you do not set this parameter, false is used. Applications of the NativeApp type run in untrusted environments and the secrets of these applications are not protected. Therefore, we recommend that you do not set this parameter to true unless otherwise specified.