REST Resource: organizations.companies.apps.keys

Resource: CompanyAppKey

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

array (ListValue format)

A list of api products this credential can be used for.

attributes[]

object (Attribute)

A list of attributes tied to the credential.

consumerKey

string

The consumer key.

consumerSecret

string

The secret key.

expiresAt

string (int64 format)

Unix time when the app was created json key: expiresAt

issuedAt

string (int64 format)

Unix time when the app was issued json key: issuedAt

scopes[]

string

The scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.

status

string

The status of the credential.

Methods

delete

Deletes a key for a company app and removes all API products associated with the app.

get

Gets information about the consumer key issued to a specific company app.

updateCompanyAppKey

Updates an existing company app key to add additional API products or attributes.