ALTER APPLICATION SET SPECIFICATIONS¶
|native-app|의 앱 사양 을 만들거나 업데이트합니다.
참고
이 명령은 |native-app|에서만 사용할 수 있습니다.
- 참고 항목:
ALTER APPLICATION, ALTER APPLICATION … { APPROVE | DECLINE} SPECIFICATION, ALTER APPLICATION DROP SPECIFICATION
구문¶
외부 액세스 통합¶
ALTER APPLICATION SET SPECIFICATION <app_spec_name>
TYPE = EXTERNAL_ACCESS
LABEL = '<label>'
DESCRIPTION = '<description>'
{ HOST_PORTS | PRIVATE_HOST_PORTS } = ( '<value>' [, '<value>', ... ] )
보안 통합(CLIENT_CREDENTIALS)¶
ALTER APPLICATION SET SPECIFICATION <app_spec_name>
TYPE = SECURITY_INTEGRATION
LABEL = '<string_literal>'
DESCRIPTION = '<string_literal>'
OAUTH_TYPE = 'CLIENT_CREDENTIALS'
OAUTH_TOKEN_ENDPOINT = '<string_literal>'
OAUTH_ALLOWED_SCOPES = ( '<scope>' [ , '<scope>' ... ] );
보안 통합(JWT_BEARER)¶
ALTER APPLICATION SET SPECIFICATION <app_spec_name>
TYPE = SECURITY_INTEGRATION
LABEL = '<string_literal>'
DESCRIPTION = '<string_literal>'
OAUTH_TYPE = 'JWT_BEARER'
OAUTH_TOKEN_ENDPOINT = '<string_literal>'
[ OAUTH_AUTHORIZATION_ENDPOINT = '<string_literal>' ]
[ OAUTH_ALLOWED_SCOPES = ( '<scope>' [ , '<scope>' ... ] ) ];
목록¶
ALTER APPLICATION SET SPECIFICATION <app_spec_name>
TYPE = LISTING
LABEL = '<string_literal>'
DESCRIPTION = '<string_literal>'
TARGET_ACCOUNTS = '<account_list>'
LISTING = <listing_name>
[ AUTO_FULFILLMENT_REFRESH_SCHEDULE = '<schedule>' ]
일반 매개 변수¶
app_spec_name앱 사양 의 식별자입니다.
TYPE = {EXTERNAL_ACCESS | SECURITY_INTEGRATION | LISTING}앱 사양의 유형을 지정합니다. 지원되는 값은 다음과 같습니다.
중요
The type of an app specification cannot be changed once it has been created. Attempting to alter the type will result in an error.
LABEL = 'label'앱 사양의 레이블을 지정합니다. 이 레이블은 컨슈머에게 표시되는 앱 사양의 이름입니다. 각 앱 사양에는 고유한 레이블이 있어야 합니다.
참고
Changing only the label will not trigger a new approval request. To require consumer approval, you must also change the app specification definition (such as HOST_PORTS, OAUTH_TOKEN_ENDPOINT, or TARGET_ACCOUNTS).
DESCRIPTION = 'description'앱 사양에 대한 설명을 지정합니다. 앱 사양 유형과 앱에 필요한 이유에 대한 정보를 포함하는 것이 좋습니다.
참고
Changing only the description will not trigger a new approval request. To require consumer approval, you must also change the app specification definition (such as HOST_PORTS, OAUTH_TOKEN_ENDPOINT, or TARGET_ACCOUNTS).
외부 액세스 통합 매개 변수¶
HOST_PORTS | PRIVATE_HOST_PORTS = ( 'value' [ , 'value', ... ] )앱이 연결할 수 있는 호스트 포트 또는 개인 호스트 포트의 목록을 지정합니다. 이러한 포트는 외부 액세스 통합에서 사용됩니다.
보안 통합 매개 변수 - CLIENT_CREDENTIALS¶
OAUTH_TYPE = 'CLIENT_CREDENTIALS'외부 API 인증에 대한 보안 통합 유형을 지정합니다. 자세한 내용은 CREATE SECURITY INTEGRATION(External API 인증) 섹션을 참조하십시오.
OAUTH_TOKEN_ENDPOINT = 'string_literal'권한 부여 또는 새로 고침 토큰을 제시하여 액세스 토큰을 얻기 위해 클라이언트가 사용하는 토큰 엔드포인트를 지정합니다. 자세한 내용은 CREATE SECURITY INTEGRATION(External API 인증) 섹션을 참조하십시오.
OAUTH_ALLOWED_SCOPES = ( 'scope' [ , 'scope' ... ] )OAuth 클라이언트 자격 증명 흐름 중에 통합에서 USAGE가 있는 역할로 OAuth에서 요청할 때 사용할 범위의 쉼표로 구분된 목록을 지정하며, 각 범위는 작은따옴표로 묶습니다. 자세한 내용은 CREATE SECURITY INTEGRATION(External API 인증) 섹션을 참조하십시오.
OAUTH_ACCESS_TOKEN_VALIDITY = integerOAuth 서버에서 발급한 OAuth 액세스 토큰의 기본 수명(초)을 지정합니다. 자세한 내용은 CREATE SECURITY INTEGRATION(External API 인증) 섹션을 참조하십시오.
보안 통합 매개 변수 - JWT_BEARER¶
OAUTH_TYPE = 'JWT_BEARER'외부 API 인증에 대한 보안 통합 유형을 지정합니다. 자세한 내용은 CREATE SECURITY INTEGRATION(External API 인증) 섹션을 참조하십시오.
OAUTH_TOKEN_ENDPOINT = 'string_literal'권한 부여 또는 새로 고침 토큰을 제시하여 액세스 토큰을 얻기 위해 클라이언트가 사용하는 토큰 엔드포인트를 지정합니다. 자세한 내용은 CREATE SECURITY INTEGRATION(External API 인증) 섹션을 참조하십시오.
OAUTH_AUTHORIZATION_ENDPOINT = 'string_literal'외부 서비스에 인증하기 위한 URL을 지정합니다. 자세한 내용은 CREATE SECURITY INTEGRATION(External API 인증) 섹션을 참조하십시오.
OAUTH_REFRESH_TOKEN_VALIDITY = integerOAuth 서버에서 발급한 OAuth 새로 고침 토큰의 기본 수명(초)을 지정합니다. 자세한 내용은 CREATE SECURITY INTEGRATION(External API 인증) 섹션을 참조하십시오.
Listing parameters¶
TARGET_ACCOUNTS = 'account_list'공백 없이 쉼표로 구분된 대상 계정의 문자열을 작은따옴표로 묶어 지정합니다. 각 계정은
OrgName.AccountName형식으로 지정해야 합니다(예:'ProviderOrg.ProviderAccount,PartnerOrg.PartnerAccount'). 사양이 승인되면 이러한 계정이 목록에 추가됩니다. 거부되면 모든 계정이 목록에서 제거됩니다.LISTING = listing_name앱에서 생성한 외부 목록의 식별자를 지정합니다. 목록이 미리 존재해야 하며 공유가 연결된 앱에서 생성한 목록이어야 합니다. 앱 사양에서 목록을 설정한 후에는 목록 이름을 변경할 수 없습니다.
AUTO_FULFILLMENT_REFRESH_SCHEDULE = 'schedule'선택 사항입니다. 리전 간 데이터 공유를 위한 새로 고침 일정을 지정합니다. 이 매개 변수는 리전 간에 데이터를 공유할 때 필요합니다. 값은 다음 두 가지 형식으로 지정할 수 있습니다.
num MINUTE: 최소 10분, 최대 11,520분(8일)의 시간(분)입니다.USING CRON expression time_zone: 새로 고침을 위한 타임존이 있는 Cron 식입니다.
사용법 노트¶
To use this command, providers must ensure that the manifest file of the app uses
manifest_version: 2.
예¶
외부 액세스를 위한 앱 사양을 만듭니다.
ALTER APPLICATION SET SPECIFICATION eai_spec
TYPE = EXTERNAL_ACCESS
LABEL = 'External API Access'
DESCRIPTION = 'Connect to external weather API'
HOST_PORTS = ('api.weather.com:443', 'api.openweather.org:443');
OAuth 보안 통합을 위한 앱 사양을 생성합니다.
ALTER APPLICATION SET SPECIFICATION oauth_spec
TYPE = SECURITY_INTEGRATION
LABEL = 'OAuth Integration'
DESCRIPTION = 'Connect to Microsoft Graph API'
OAUTH_TYPE = 'CLIENT_CREDENTIALS'
OAUTH_TOKEN_ENDPOINT = 'https://login.microsoftonline.com/YOUR_TENANT_ID/oauth2/v2.0/token'
OAUTH_ALLOWED_SCOPES = ('https://graph.microsoft.com/.default');
목록을 통한 데이터 공유를 위한 앱 사양을 생성합니다.
ALTER APPLICATION SET SPECIFICATION shareback_spec
TYPE = LISTING
LABEL = 'Telemetry Data Sharing'
DESCRIPTION = 'Share telemetry and usage data with provider'
TARGET_ACCOUNTS = 'ProviderOrg.ProviderAccount,PartnerOrg.PartnerAccount'
LISTING = telemetry_listing
AUTO_FULFILLMENT_REFRESH_SCHEDULE = '720 MINUTE';