# @datadog/datadog-api-client-roles

Latest version **0.0.1-beta.2** (published 2025-12-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @datadog/datadog-api-client-roles
pnpm add @datadog/datadog-api-client-roles
yarn add @datadog/datadog-api-client-roles
bun add @datadog/datadog-api-client-roles
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high maintenance score.

Warnings: low downloads; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.0.1-beta.2 |
| Published | 2025-12-17 |
| First published | 2025-06-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18.0.0 |
| Dependencies | 1 |
| Unpacked size | 259.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 104 |
| Maintainers | datadog |
| Keywords | api, fetch, typescript |

## Links

- npm: https://www.npmjs.com/package/@datadog/datadog-api-client-roles
- Repository: https://github.com/DataDog/datadog-api-client-typescript
- npm.io page: https://npm.io/package/@datadog/datadog-api-client-roles

## Dependencies (1)

- [@datadog/datadog-api-client](https://npm.io/package/@datadog/datadog-api-client.md) ^2.0.0-beta.2

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.0.1-beta.2 (latest) — 2025-12-17
- 0.0.1-beta.6 (beta) — 2026-05-15
- 0.0.1-beta.5 — 2026-04-24
- 0.0.1-beta.3 — 2026-03-06
- 0.0.1-beta.1 — 2025-06-05

## README

# @datadog/datadog-api-client-roles

## Description

The Roles API is used to create and manage Datadog roles, what
[global permissions](https://docs.datadoghq.com/account_management/rbac/)
they grant, and which users belong to them.

Permissions related to specific account assets can be granted to roles
in the Datadog application without using this API. For example, granting
read access on a specific log index to a role can be done in Datadog from the
[Pipelines page](https://app.datadoghq.com/logs/pipelines).

## Navigation

- [Installation](#installation)
- [Getting Started](#getting-started)

## Installation

```sh
# NPM
npm install @datadog/datadog-api-client-roles
# Yarn
yarn add @datadog/datadog-api-client-roles
```

## Getting Started
```ts
import { createConfiguration } from "@datadog/datadog-api-client";
import { RolesApiV2 } from "@datadog/datadog-api-client-roles";
import { v2 } from "@datadog/datadog-api-client-roles";

const configuration = createConfiguration();
const apiInstance = new RolesApiV2(configuration);

apiInstance.listPermissions().then((data) => {
    console.log("API called successfully. Returned data: " + JSON.stringify(data));
}).catch((error) => {
    console.error("Error calling API: " + error);
});
```

---
_Source: https://npm.io/package/@datadog/datadog-api-client-roles · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._