Interface Role

interface Role {
    description?: string;
    name: string;
    permissions: {
        ContentDelivery: string | string[];
        ContentModel: string[];
        EnvironmentAliases: string | string[];
        Environments: string | string[];
        Settings: string | string[];
        Tags: string | string[];
    };
    policies: {
        actions: "all" | ActionType[];
        constraint: ConstraintType;
        effect: string;
    }[];
    sys: BasicMetaSysProps & {
        space: SysLink;
    };
    delete(): Promise<void>;
    toPlainObject(): RoleProps;
    update(): Promise<Role>;
}

Hierarchy (view full)

Properties

description? name permissions policies sys

Methods

delete toPlainObject update

Properties

Optionaldescription

description?: string

name

name: string

permissions

permissions: {
    ContentDelivery: string | string[];
    ContentModel: string[];
    EnvironmentAliases: string | string[];
    Environments: string | string[];
    Settings: string | string[];
    Tags: string | string[];
}

Permissions for application sections

policies

policies: {
    actions: "all" | ActionType[];
    constraint: ConstraintType;
    effect: string;
}[]

sys

sys: BasicMetaSysProps & {
    space: SysLink;
}

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.

    Memberof

    Role

    Func

    delete

    Example: ```javascript const contentful = require('contentful-management') const client = contentful.createClient({ accessToken: '<content_management_api_key>' }) client.getSpace('<space_id>') .then((space) => space.getRole('<role_id>')) .then((role) => role.delete()) .then((role) => console.log(`role deleted.`)) .catch(console.error) ```

toPlainObject

update

  • update(): Promise<Role>

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

    Returns Promise<Role>

    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.getRole('<roles_id>')) .then((roles) => { roles.name = 'New role name' return roles.update() }) .then((roles) => console.log(`roles ${roles.sys.id} updated.`)) .catch(console.error) ```

Settings

Member Visibility

On This Page

Properties
Methods