REST Resource: organizations.developers.apps.keys

Resource: DeveloperAppKey

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

array (ListValue format)

List of API products for which the credential can be used.

Note: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the keys.updateDeveloperAppKey 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

Consumer key.

consumerSecret

string

Secret key.

expiresAt

string (int64 format)

Time the developer app expires in milliseconds since epoch.

issuedAt

string (int64 format)

Time the developer 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)

Input only. 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.

Methods

create

Creates a custom consumer key and secret for a developer 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 developer app, including the key and secret value, associated API products, and other information.

replaceDeveloperAppKey

Updates the scope of an app.

updateDeveloperAppKey

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