Sign in

v1

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

Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. Note: We recommend that you avoid making concurrent update requests for the same resource. Near-simultaneous writes to the same entity can result in conflicts and unexpected behavior. Ensure operations are sequential when modifying a single resource.

put/v1/{+name}

Path parameters

namestring required

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

Query parameters

actionstring

Approve or revoke the consumer key by setting this value to approve or revoke. The Content-Type header must be set to application/octet-stream, with empty body.

ignoreNewlineValidationboolean

Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.

Request body

callbackUrlstring

Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.

appIdstring

Immutable. ID of the AppGroup app.

keyExpiresInstring int64

Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. 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.

appGroupstring

Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations//appgroups/).

apiProductsstring[]

List of API products associated with the AppGroup app.

scopesstring[]

Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.

namestring

Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations//appgroups//apps/*).

lastModifiedAtstring int64

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

createdAtstring int64

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

statusstring

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

Response

Successful response