POST
/
v1
/
roles
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.roles.createRole({
  body: {},
})
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "isSystem": true,
  "permissions": [
    "<string>"
  ],
  "createdAt": "<string>"
}

Body

application/json
name
string
required

a string at most 64 character(s) long

Required string length: 2 - 64
permissions
string[]
required

Response

Success

id
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
name
string
required
isSystem
boolean
required
permissions
string[]
required
createdAt
string
required