v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.

post/v1/{+parent}/keys

Path parameters

parentstring required

Required. Parent of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys

Request body

scopesstring[]

Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.

statusstring

Status of the credential. Valid values include approved or revoked.

consumerKeystring

Immutable. Consumer key.

consumerSecretstring

Secret key.

issuedAtstring int64

Output only. Time the AppGroup app was created in milliseconds since epoch.

expiresInSecondsstring int64

Immutable. Expiration time, in seconds, for the consumer key. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.

expiresAtstring int64

Output only. Time the AppGroup app expires in milliseconds since epoch.

Response

Successful response