Sign in

v44

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-20129390589.6 KB
Roles

Create role

⚠️ This endpoint is in public preview.

Create a role.

post/preview/v2/roles

Request body

namestring required

Example request

{
  "name": "my-resource-name"
}

Response

Role created.

idstring required
resource_pathstring required

A resource path for a role resource. Format: sfc:role:<account>:<name>.

ownerstring required
namestring required
object'role' required
role_type'built_in' | 'custom' required
created_atinteger required

Unix timestamp.

updated_atinteger required

Unix timestamp.

Example response

{
  "id": "role_k3R-nX9vLm7Qp2Yw5Jd8F",
  "resource_path": "sfc:role:<account_id>:<name>",
  "owner": "my-resource-name",
  "name": "my-resource-name",
  "object": "role",
  "created_at": 1738972800,
  "updated_at": 1738972800
}