Skip to content

AuthorizationProps

Properties for defining a Authorization.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-authorization

Initializer 

import { AuthorizationProps } from '@alicloud/ros-cdk-apigateway'
const authorizationProps: AuthorizationProps = { ... }

Properties

Name Type Description
apiIds any[] | @alicloud/ros-cdk-core.IResolvable Property apiIds: APIs to authorize.
appIds any[] | @alicloud/ros-cdk-core.IResolvable Property appIds: APPs are authorized to APIs.
groupId string | @alicloud/ros-cdk-core.IResolvable Property groupId: The id of the group.
stageName string | @alicloud/ros-cdk-core.IResolvable Property stageName: Authorize in this stage.
authValidTime string | @alicloud/ros-cdk-core.IResolvable Property authValidTime: The time (UTC) when the authorization expires.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of the authorization, less than 180 characters.

apiIdsRequired 

public readonly apiIds: any[] | IResolvable;
  • Type: any[] | @alicloud/ros-cdk-core.IResolvable

Property apiIds: APIs to authorize.

appIdsRequired 

public readonly appIds: any[] | IResolvable;
  • Type: any[] | @alicloud/ros-cdk-core.IResolvable

Property appIds: APPs are authorized to APIs.

groupIdRequired 

public readonly groupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property groupId: The id of the group.

stageNameRequired 

public readonly stageName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property stageName: Authorize in this stage.

authValidTimeOptional 

public readonly authValidTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property authValidTime: The time (UTC) when the authorization expires.

If this parameter is empty, the authorization does not expire. Pattern: YYYY-MM-DDThh:mm:ssZ

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Description of the authorization, less than 180 characters.