Interface AppKey

interface AppKey {
    generated?: {
        privateKey: string;
    };
    jwk: JWK;
    sys: AppKeySys;
    delete(): Promise<void>;
    toPlainObject(): AppKeyProps;
}

Hierarchy (view full)

Properties

generated? jwk sys

Methods

delete toPlainObject

Properties

Optionalgenerated

generated?: {
    privateKey: string;
}

If generated, private key is returned

Type declaration

  • privateKey: string

    Base64 PEM

jwk

jwk: JWK

JSON Web Key

sys

sys: AppKeySys

System metadata

Methods

delete

  • delete(): Promise<void>

  • Deletes this object on the server.

    Returns Promise<void>

    Promise for the deletion. It contains no data, but the Promise error case should be handled.

    Example: ```javascript const contentful = require('contentful-management') const client = contentful.createClient({ accessToken: '<content_management_api_key>' }) client.getOrganization('<organization_id>') .then((organization) => organization.getAppKey(<api-key-id>)) .then((signingSecret) => signingSecret.delete()) .then(() => console.log('signingSecret deleted')) .catch(console.error) ```

toPlainObject

Settings

Member Visibility

On This Page

Properties
Methods