Create a Role

Create a new role.

POST /v1/roles

Parameters

Parameter	Description	Type	Required
roleId	A string identifier for the role. A roleId must be composed of alphanumeric chars and/or _, -, ., @, |, and :.	JSON body	yes
name	An optional, display-friendly name for the role.	JSON body	no
description	An optional description of the role. A useful description might include a summary of the permissions the role grants.	JSON body	no

Request

Curl

curl "https://api.warrant.dev/v1/roles" \
    -X POST \
    -H "Authorization: ApiKey YOUR_KEY" \
    --data-raw \
    '{
        "roleId": "customer-success",
        "name": "Customer Success",
        "description": "Grants read-only access to customer accounts"
     }'

Go

createdRole, err := role.Create(&warrant.RoleParams{
    RoleId: "customer-success",
    Name: "Customer Success",
    Description: "Grants read-only access to customer accounts",
})
if err != nil {
    // handle error
}

Java

try {
    Role newRole = client.createRole(new Role(
        "customer-success",
        "Customer Success",
        "Grants read-only access to customer accounts"
    ));
} catch (WarrantException e) {
    // Handle error
}

Node.js

const newRole = await warrantClient.Role.create({
  roleId: "customer-success",
  name: "Customer Success",
  description: "Grants read-only access to customer accounts",
});

Python

role = warrant.Role.create("customer-success", "Customer Success", "Grants read-only access to customer accounts")

Ruby

role = Warrant::Role.create(
    role_id: "customer-success",
    name: "Customer Success",
    description: "Grants read-only access to customer accounts"
)

PHP

$role = $warrant->createRole(new \Warrant\Role("customer-success", "Customer Success", "Grants read-only access to customer accounts"));

CLI

warrant create role customer-success

Response

{
  "roleId": "customer-success",
  "name": "Customer Success",
  "description": "Grants read-only access to customer accounts"
}