Create an Object

Create a new object.

Endpoint

POST /v1/objects

Request

Body

Parameter	Type	Description	Required
objectType	string	The type of the object (e.g. user, tenant, role, permission, etc).	yes
objectId	string	Customer defined string identifier for this object. Can only contain alphanumeric chars and/or '-', '_', '|', '@'. If not provided, Warrant will create a univerally unique identifier (UUID) for the object and return it. If allowing Warrant to generate an id, store the id in your application so you can provide it for authorization requests on that object.	no
meta	object	A JSON object containing additional information about this object (e.g. role name/description, user email/name, etc.) to be persisted to Warrant.	no

cURL

POST /v1/objects

curl "https://api.warrant.dev/v1/objects" \
  -X POST \
  -H "Authorization: ApiKey YOUR_KEY" \
  --data-raw \
  '{
     "objectType":"user",
     "objectId":"d6ed6474-784e-407e-a1ea-42a91d4c52b9"
   }'

CLI

POST /v1/objects

warrant create user:d6ed6474-784e-407e-a1ea-42a91d4c52b9

Go

POST /v1/objects

user, err := object.Create(&warrant.ObjectParams{
    ObjectType: "user",
    ObjectId: "d6ed6474-784e-407e-a1ea-42a91d4c52b9",
})

Java

POST /v1/objects

WarrantObject newUser = client.createObject(
    new WarrantObject("user", "d6ed6474-784e-407e-a1ea-42a91d4c52b9")
);

Node.js

POST /v1/objects

const newUser = await warrantClient.Object.create({
  objectType: "user",
  objectId: "d6ed6474-784e-407e-a1ea-42a91d4c52b9",
});

PHP

POST /v1/objects

$user = $warrant->createObject(new \Warrant\Object("user", "d6ed6474-784e-407e-a1ea-42a91d4c52b9"));

Python

POST /v1/objects

user = warrant.Object.create(object_type="user", object_id="d6ed6474-784e-407e-a1ea-42a91d4c52b9")

Ruby

POST /v1/objects

user = Warrant::Object.create(object_type: "user", object_id: "d6ed6474-784e-407e-a1ea-42a91d4c52b9")

Response

200 OK

{
  "objectType": "user",
  "objectId": "dkfi7a0s-784e-407e-a1ea-42a91d4c52b9"
}