Create Resource

Create a new resource domain and define its permissions in a single request.

Endpoint

/api/v1/projects/{project_id}/resources

Method

POST

Path Parameters

Parameter	Type	Required	Description
`project_id`	`string`	Yes	Unique ID of the project

Headers

Header	Required	Description
`Content-Type`	Yes	`application/json`
`Authorization`	Yes	Bearer access token: `Bearer <access_token>`

Request Body

Field	Type	Required	Description
`name`	`string`	Yes	Resource name (max 50 chars)
`code`	`string`	Yes	Resource code identifier (alphanumeric, dash, underscore, max 50 chars)
`description`	`string`	No	Description (max 200 chars)
`permissions`	`array of objects`	No	List of permissions (`name`, `code`, `description`)

Required Permission

resources:create

Examples

curl --request POST \
  --url https://auth.roled.io/api/v1/projects/2JUSLUee46xG6iEwG8JwPc/resources \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJo...' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Products",
    "code": "products",
    "description": "Product catalog",
    "permissions": [
      {
        "name": "Create",
        "code": "create",
        "description": "Create a new product"
      },
      {
        "name": "Read",
        "code": "read",
        "description": "List and view products"
      },
      {
        "name": "Update",
        "code": "update",
        "description": "Edit an existing product"
      },
      {
        "name": "Delete",
        "code": "delete",
        "description": "Remove a product"
      }
    ]
  }'

{
  "success": true,
  "data": {
    "id": "2JUUyotLU97ZghzqwrqE6o",
    "created_at": "2026-07-26T00:32:27Z",
    "updated_at": "2026-07-26T00:32:27Z",
    "name": "Products",
    "code": "products",
    "description": "Product catalog",
    "is_default": false,
    "permissions": [
      {
        "id": "2JUUyotLUqz5eqsuYXXDet",
        "name": "Create",
        "code": "create",
        "description": "Create a new product",
        "is_default": false
      },
      {
        "id": "2JUUyotLUr7SuBqkzjRbTc",
        "name": "Read",
        "code": "read",
        "description": "List and view products",
        "is_default": false
      },
      {
        "id": "2JUUyotLUrApxL7zcx7Xoy",
        "name": "Update",
        "code": "update",
        "description": "Edit an existing product",
        "is_default": false
      },
      {
        "id": "2JUUyotLUrDfBK9iwe25jj",
        "name": "Delete",
        "code": "delete",
        "description": "Remove a product",
        "is_default": false
      }
    ]
  }
}

Error Codes

Code	HTTP Status	Description
`invalid_params`	400	Invalid or missing request parameters, headers, or body.
`invalid_authorization_token`	401	Unauthorized request. The authorization token is missing or invalid.
`insufficient_permission`	403	Insufficient permissions to access this resource.
`project_not_found`	404	The requested project could not be found.
`resource_code_already_used`	409	A resource with this code already exists in the project.
`system_error`	500	An unexpected error occurred. Please try again later.

Get Resource Details Update Resource