Skip to content

ApplicationProps

Properties for defining a Application.

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

Initializer 

import com.aliyun.ros.cdk.ram.ApplicationProps;
ApplicationProps.builder()
    .appName(java.lang.String)
    .appName(IResolvable)
    .appType(java.lang.String)
    .appType(IResolvable)
    .displayName(java.lang.String)
    .displayName(IResolvable)
//  .accessTokenValidity(java.lang.Number)
//  .accessTokenValidity(IResolvable)
//  .isMultiTenant(java.lang.Boolean)
//  .isMultiTenant(IResolvable)
//  .predefinedScopes(IResolvable)
//  .predefinedScopes(java.util.List<java.lang.String)
//  .predefinedScopes(IResolvable>)
//  .redirectUris(IResolvable)
//  .redirectUris(java.util.List<java.lang.String)
//  .redirectUris(IResolvable>)
//  .refreshTokenValidity(java.lang.Number)
//  .refreshTokenValidity(IResolvable)
//  .requiredScopes(IResolvable)
//  .requiredScopes(java.util.List<java.lang.String)
//  .requiredScopes(IResolvable>)
//  .secretRequired(java.lang.Boolean)
//  .secretRequired(IResolvable)
    .build();

Properties

Name Type Description
appName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property appName: The name of the application.
appType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property appType: The type of the application.
displayName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property displayName: The display name of the application.
accessTokenValidity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property accessTokenValidity: The validity period of the access token.
isMultiTenant java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isMultiTenant: Indicates whether the application can be installed by using other Alibaba Cloud accounts.
predefinedScopes com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property predefinedScopes: List of the scopes of application permissions.
redirectUris com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property redirectUris: List of the callback URLs.
refreshTokenValidity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property refreshTokenValidity: The validity period of the refreshed token.
requiredScopes com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property requiredScopes: Required scope of application permissions.
secretRequired java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property secretRequired: Indicates whether a secret is required.

appNameRequired 

public java.lang.Object getAppName();
  • Type: java.lang.String OR com.aliyun.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 (-).

appTypeRequired 

public java.lang.Object getAppType();
  • Type: java.lang.String OR com.aliyun.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.

displayNameRequired 

public java.lang.Object getDisplayName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property displayName: The display name of the application.

The name can be up to 24 characters in length.

accessTokenValidityOptional 

public java.lang.Object getAccessTokenValidity();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property accessTokenValidity: The validity period of the access token.

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

isMultiTenantOptional 

public java.lang.Object getIsMultiTenant();
  • Type: java.lang.Boolean OR com.aliyun.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.

predefinedScopesOptional 

public java.lang.Object getPredefinedScopes();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property predefinedScopes: List of the scopes of application permissions.

redirectUrisOptional 

public java.lang.Object getRedirectUris();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property redirectUris: List of the callback URLs.

refreshTokenValidityOptional 

public java.lang.Object getRefreshTokenValidity();
  • Type: java.lang.Number OR com.aliyun.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.

requiredScopesOptional 

public java.lang.Object getRequiredScopes();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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.

secretRequiredOptional 

public java.lang.Object getSecretRequired();
  • Type: java.lang.Boolean OR com.aliyun.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.