Modifies the configurations of an application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateApplication

The operation that you want to perform. Set the value to UpdateApplication.
AppId String Yes 472457090344041****

The ID of the application.
NewDisplayName String No NewApp

The new display name of the application.
NewRedirectUris String No https://www.example.com

The new callback URL.

Separate multiple callback URLs with semicolons (;).
NewPredefinedScopes String No openid

The new scope of application permissions.

For more information about the application permission scope, see Open authorization scope. You can also call the ListPredefinedScopes operation to obtain the permission scopes supported by different types of applications.

Separate multiple permission scopes with semicolons (;).

If you specify a new permission scope, the new permission scope takes effect. For example, if the original permission scope is /acs/ccc, and the new permission scope is /acs/alidns, /acs/alidns takes effect. If you want to retain the original permission scope, set the new permission scope to /acs/ccc;/acs/alidns.
NewSecretRequired Boolean No true

Specifies whether a secret is required. Valid values:

  • true
  • 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. For more information, see Use an application of the NativeApp type to log on to Alibaba Cloud.
NewAccessTokenValidity Integer No 3600

The validity period of the new access token.

Valid values: 900 to 10800. Unit: seconds.
NewRefreshTokenValidity Integer No 7776000

The validity period of the refreshed token.

Valid values: 7200 to 31536000. Unit: seconds.
NewIsMultiTenant Boolean No true

Specifies whether the application can be installed by using other Alibaba Cloud accounts. Valid values:

  • true
  • false

Response parameters

Parameter Type Example Description
Application Struct

The information of the application.
AccessTokenValidity Integer 3600

The validity period of the access token. Unit: seconds.
AccountId String 177242285274****

The ID of the Alibaba Cloud account to which the application belongs.
AppId String 472457090344041****

The ID of the application.
AppName String myapp

The name of the application.
AppType String WebApp

The type of the application.
CreateDate String 2020-10-23T08:06:57Z

The creation time.
DelegatedScope Struct

The information of application permissions.
PredefinedScopes Array of PredefinedScope

The information of application permissions.
PredefinedScope
Description String Obtain the OpenID of the user. This is the default permission that you cannot remove.

The description of the permission scope.
Name String openid

The name of the scope.
DisplayName String NewApp

The display name of the application.
IsMultiTenant Boolean true

Indicates whether the application can be installed by using other Alibaba Cloud accounts.
RedirectUris List https://www.example.com

The callback URL.
RefreshTokenValidity Integer 7776000

The validity period of the refreshed token. Unit: seconds.
SecretRequired Boolean true

Indicates whether a secret is required.
UpdateDate String 2020-10-23T08:06:57Z

The update time.
RequestId String 6616F09B-2768-4C11-8866-A8EE4C4A583E

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=UpdateApplication
&AppId=472457090344041****
&NewDisplayName=NewApp
&<Common request parameters>

Sample success responses

XML format

<UpdateApplicationResponse>
	  <RequestId>A4AE08F4-36FB-4274-BE4A-6BCAF7F15E85</RequestId>
	  <Application>
		    <AccountId>177242285274****</AccountId>
		    <SecretRequired>true</SecretRequired>
		    <IsMultiTenant>true</IsMultiTenant>
		    <CreateDate>2020-10-23T08:06:57Z</CreateDate>
		    <AppName>myapp</AppName>
		    <UpdateDate>2020-11-02T07:02:06Z</UpdateDate>
		    <DelegatedScope>
			      <PredefinedScopes>
				        <PredefinedScope>
					          <Description>Obtain the OpenID of the user. This is the default permission that you cannot remove.</Description>
					          <Name>openid</Name>
				        </PredefinedScope>
			      </PredefinedScopes>
		    </DelegatedScope>
		    <AppId>472457090344041****</AppId>
		    <DisplayName>NewApp</DisplayName>
		    <AccessTokenValidity>3600</AccessTokenValidity>
		    <RedirectUris>
			      <RedirectUri>https://www.example.com</RedirectUri>
		    </RedirectUris>
		    <RefreshTokenValidity>7776000</RefreshTokenValidity>
		    <AppType>WebApp</AppType>
	  </Application>
</UpdateApplicationResponse>

JSON format

{
  "RequestId": "A4AE08F4-36FB-4274-BE4A-6BCAF7F15E85",
  "Application": {
    "AccountId": "177242285274****",
    "SecretRequired": true,
    "IsMultiTenant": true,
    "CreateDate": "2020-10-23T08:06:57Z",
    "AppName": "myapp",
    "UpdateDate": "2020-11-02T07:02:06Z",
    "DelegatedScope": {
      "PredefinedScopes": {
        "PredefinedScope": [
          {
            "Description": "Obtain the OpenID of the user. This is the default permission that you cannot remove.",
            "Name": "openid"
          }
        ]
      }
    },
    "AppId": "472457090344041****",
    "DisplayName": "NewApp",
    "AccessTokenValidity": 3600,
    "RedirectUris": {
      "RedirectUri": [
        "https://www.example.com"
      ]
    },
    "RefreshTokenValidity": 7776000,
    "AppType": "WebApp"
  }
}

Error codes

For a list of error codes, visit the API Error Center.