Skip to content

Create permission template

POST
/v3/authorization/permissions/templates
curl --request POST \
--url https://us-gov.legion.picogrid.com/v3/authorization/permissions/templates \
--header 'Content-Type: application/json' \
--data '{ "description": "Standard entity viewing permissions", "name": "Entity Viewer", "permissions": { "entity": [ {} ] } }'

Create a new permission template. Requires organization context and organizations:users:write scope.

Media typeapplication/json
object
description
string
>= 1 characters <= 1000 characters
name
string
>= 1 characters <= 100 characters
permissions
required
object
Example
{
"description": "Standard entity viewing permissions",
"name": "Entity Viewer",
"permissions": {
"entity": [
{}
]
}
}

Resource created successfully

Media typeapplication/json
object
created_at
required
string
created_by
string format: uuid
description
string
>= 1 characters <= 1000 characters
icon
string
id
string format: uuid
is_system
required
boolean
name
string
>= 1 characters <= 100 characters
organization_id
string format: uuid
permissions
required
object
updated_at
required
string
Example
{
"created_at": "2024-02-16T21:45:33Z",
"created_by": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"description": "Standard entity viewing permissions",
"icon": "entity-icon",
"id": "123e4567-e89b-12d3-a456-426614174000",
"is_system": "false",
"name": "Entity Viewer",
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"permissions": {
"entity": [
{}
]
},
"updated_at": "2024-02-16T21:45:33Z"
}

Bad Request

Media typeapplication/json
object
category
string
code
number
details
Array<object>
object
field
required
string
issue
required
string
message
string
status
string
timestamp
string
trace_id
string
Example
{
"code": "400",
"details": "sample_value",
"message": "Request cannot be processed due to invalid input",
"status": "error",
"timestamp": "2025-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Unauthorized

Media typeapplication/json
object
category
string
code
number
details
Array<object>
object
field
required
string
issue
required
string
message
string
status
string
timestamp
string
trace_id
string
Example
{
"code": "401",
"details": "sample_value",
"message": "Authentication credentials are missing or invalid",
"status": "error",
"timestamp": "2025-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Forbidden

Media typeapplication/json
object
category
string
code
number
details
Array<object>
object
field
required
string
issue
required
string
message
string
status
string
timestamp
string
trace_id
string
Example
{
"code": "403",
"details": "sample_value",
"message": "Access denied: insufficient permissions for this resource",
"status": "error",
"timestamp": "2025-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Not Found

Media typeapplication/json
object
category
string
code
number
details
Array<object>
object
field
required
string
issue
required
string
message
string
status
string
timestamp
string
trace_id
string
Example
{
"code": "404",
"details": "sample_value",
"message": "The requested resource could not be found",
"status": "error",
"timestamp": "2025-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Internal Server Error

Media typeapplication/json
object
category
required

The category of the error

string
code
required

The HTTP status code

number
details
required

Additional details about the error

Array<object>
object
field

The field that caused the error

string
issue

The specific issue with the field

string
message
required

A human-readable error message

string
status
required

The status of the response, always ‘error’ for error responses

string
timestamp
required

The timestamp when the error occurred

string format: date-time
trace_id
required

A unique identifier for tracing the error

string format: uuid
Example
{
"category": "server_error",
"code": "500",
"details": [
{
"field": "field_name",
"issue": "Field validation issue"
}
],
"message": "Internal Server Error",
"status": "error",
"timestamp": "2024-03-15T10:30:00Z",
"trace_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f"
}

Version 3.0.0 · commit 0771262