Interface ApiKey

interface ApiKey {
    accessToken: string;
    description?: string;
    environments: {
        sys: MetaLinkProps;
    }[];
    name: string;
    policies?: {
        action: string;
        effect: string;
    }[];
    preview_api_key: {
        sys: MetaLinkProps;
    };
    sys: MetaSysProps;
    delete(): Promise<void>;
    toPlainObject(): ApiKeyProps;
    update(): Promise<ApiKey>;
}

Hierarchy (view full)

Properties

accessToken description? environments name policies? preview_api_key sys

Methods

delete toPlainObject update

Properties

accessToken

accessToken: string

Optionaldescription

description?: string

environments

environments: {
    sys: MetaLinkProps;
}[]

name

name: string

Optionalpolicies

policies?: {
    action: string;
    effect: string;
}[]

preview_api_key

preview_api_key: {
    sys: MetaLinkProps;
}

sys

sys: MetaSysProps

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.getSpace('<space_id>') .then((space) => space.getApiKey(<api-key-id>)) .then((apiKey) => apiKey.delete()) .then(() => console.log('apikey deleted')) .catch(console.error) ```

toPlainObject

update

  • update(): Promise<ApiKey>

  • Sends an update to the server with any changes made to the object's properties

    Returns Promise<ApiKey>

    Object returned from the server with updated changes.

    Example: ```javascript const contentful = require('contentful-management') const client = contentful.createClient({ accessToken: '<content_management_api_key>' }) client.getSpace('<space_id>') .then((space) => space.getApiKey(<api-key-id>)) .then((apiKey) => { apiKey.name = 'New name' return apiKey.update() }) .then(apiKey => console.log(apiKey.name)) .catch(console.error) ```

Settings

Member Visibility

On This Page

Properties
Methods