REST Resource: organizations.appgroups.apps.keys

Resource: AppGroupAppKey

AppGroupAppKey contains all the information associated with the credentials.

JSON representation
{
  "apiProducts": [
    {
      object (APIProductAssociation)
    }
  ],
  "attributes": [
    {
      object (Attribute)
    }
  ],
  "consumerKey": string,
  "consumerSecret": string,
  "expiresAt": string,
  "issuedAt": string,
  "scopes": [
    string
  ],
  "status": string,
  "expiresInSeconds": string
}
Fields
apiProducts[]

object (APIProductAssociation)

Output only. List of API products and its status for which the credential can be used. Note: Use [UpdateAppGroupAppKeyApiProductRequest][AppGroupAppKeys.UpdateAppGroupAppKeyApiProductRequest] API to make the association after the consumer key and secret are created.

attributes[]

object (Attribute)

List of attributes associated with the credential.

consumerKey

string

Immutable. Consumer key.

consumerSecret

string

Secret key.

expiresAt

string (int64 format)

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

issuedAt

string (int64 format)

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

scopes[]

string

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

status

string

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

expiresInSeconds

string (int64 format)

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.

APIProductAssociation

APIProductAssociation has the API product and its administrative state association.

JSON representation
{
  "apiproduct": string,
  "status": string
}
Fields
apiproduct

string

API product to be associated with the credential.

status

string

The API product credential associated status. Valid values are approved or revoked.

Methods

create

Creates a custom consumer key and secret for a AppGroup app.

delete

Deletes an app's consumer key and removes all API products associated with the app.

get

Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information.

updateAppGroupAppKey

Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product.