Create Role

Beta

POST/v1/identity/roles

Idempotent with Idempotency-Key header. Learn more

Creates a new role with the specified permissions.

include[]optional arrayenumValues:ownerowner.accountpermissions

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

namestring

Display name.

permissionsarray of string

Permissions to attach in <domain>:<action> format.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

The role's type is sometimes used to gate special behaviors in the frontend and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

ownerobjectExpandablenullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.

portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringExpandablenullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Role

Create Role

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const role = await client.identity.roles.create({
  name: 'Warehouse Manager',
  permissions: ['customers:create', 'customers:read', 'customers:update', 'invoices:read'],
});

console.log(role.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const role = await client.identity.roles.create({
  name: 'Warehouse Manager',
  permissions: ['customers:create', 'customers:read', 'customers:update', 'invoices:read'],
});

console.log(role.id);

201 example

{
  "id": "rl_01c16d2eb637c0d1f3a372937c",
  "object": "role",
  "name": "Admin",
  "type": "admin",
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_01148680966698341a9c0976db",
      "object": "account",
      "name": "Acme Inc.",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "permissions": [
    "customers:create",
    "customers:read",
    "customers:update",
    "customers:delete"
  ],
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "rl_01c16d2eb637c0d1f3a372937c",
  "object": "role",
  "name": "Admin",
  "type": "admin",
  "owner": {
    "object": "owner",
    "type": "account",
    "account": {
      "id": "ac_01148680966698341a9c0976db",
      "object": "account",
      "name": "Acme Inc.",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "permissions": [
    "customers:create",
    "customers:read",
    "customers:update",
    "customers:delete"
  ],
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Role

Query Parameters

Request Body

Returns

Responses