Show examples in:
    List all roles

    Returns

    Returns an array of role resource objects.

    Examples

    Example code:
    import { buildClient } from '@datocms/cma-client-node';
    async function run() {
    const client = buildClient({ apiToken: '<YOUR_API_TOKEN>' });
    const roles = await client.roles.list();
    roles.forEach((role) => {
    console.log(role);
    });
    }
    run();
    Returned output:
    {
    id: '34',
    name: 'Editor',
    can_edit_favicon: true,
    can_edit_site: true,
    can_edit_schema: true,
    can_manage_menu: true,
    can_edit_environment: true,
    can_promote_environments: true,
    environments_access: 'primary_only',
    can_manage_users: true,
    can_manage_shared_filters: true,
    can_manage_build_triggers: true,
    can_manage_webhooks: true,
    can_manage_environments: true,
    can_manage_sso: true,
    can_access_audit_log: true,
    can_manage_workflows: true,
    can_manage_access_tokens: true,
    can_perform_site_search: true,
    can_access_build_events_log: true,
    positive_item_type_permissions: [
    {
    item_type: '44',
    workflow: 'approval_by_editors',
    on_stage: '',
    to_stage: '',
    environment: 'main',
    action: 'all',
    on_creator: 'self',
    localization_scope: 'all',
    locale: 'en'
    }
    ],
    negative_item_type_permissions: [
    {
    item_type: '44',
    workflow: 'approval_by_editors',
    on_stage: '',
    to_stage: '',
    environment: 'main',
    action: 'all',
    on_creator: 'self',
    localization_scope: 'all',
    locale: 'en'
    }
    ],
    positive_upload_permissions: [
    {
    environment: 'main',
    action: 'all',
    on_creator: 'self',
    localization_scope: 'all',
    locale: 'en'
    }
    ],
    negative_upload_permissions: [
    {
    environment: 'main',
    action: 'all',
    on_creator: 'self',
    localization_scope: 'all',
    locale: 'en'
    }
    ],
    positive_build_trigger_permissions: [
    {
    build_trigger: '1822'
    }
    ],
    negative_build_trigger_permissions: [
    {
    build_trigger: '1822'
    }
    ],
    meta: {
    final_permissions: {
    can_edit_favicon: true,
    can_edit_site: true,
    can_edit_schema: true,
    can_manage_menu: true,
    can_edit_environment: true,
    can_promote_environments: true,
    environments_access: 'primary_only',
    can_manage_users: true,
    can_manage_shared_filters: true,
    can_manage_build_triggers: true,
    can_manage_webhooks: true,
    can_manage_environments: true,
    can_manage_sso: true,
    can_access_audit_log: true,
    can_manage_workflows: true,
    can_manage_access_tokens: true,
    can_perform_site_search: true,
    can_access_build_events_log: true,
    positive_item_type_permissions: [
    {
    item_type: '44',
    workflow: 'approval_by_editors',
    on_stage: '',
    to_stage: '',
    environment: 'main',
    action: 'all',
    on_creator: 'self',
    localization_scope: 'all',
    locale: 'en'
    }
    ],
    negative_item_type_permissions: [
    {
    item_type: '44',
    workflow: 'approval_by_editors',
    on_stage: '',
    to_stage: '',
    environment: 'main',
    action: 'all',
    on_creator: 'self',
    localization_scope: 'all',
    locale: 'en'
    }
    ],
    positive_upload_permissions: [
    {
    environment: 'main',
    action: 'all',
    on_creator: 'self',
    localization_scope: 'all',
    locale: 'en'
    }
    ],
    negative_upload_permissions: [
    {
    environment: 'main',
    action: 'all',
    on_creator: 'self',
    localization_scope: 'all',
    locale: 'en'
    }
    ],
    positive_build_trigger_permissions: [
    {
    build_trigger: '1822'
    }
    ],
    negative_build_trigger_permissions: [
    {
    build_trigger: '1822'
    }
    ]
    }
    },
    inherits_permissions_from: [
    {
    type: 'role',
    id: '34'
    }
    ]
    }