User Permission

The user permission resource.

Basehttps://rest.carbon.ms/userPermission

GET/userPermission

List user permissions

Retrieve a paginated list of user permissions. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/userPermission

curl --request GET \
  --url 'https://rest.carbon.ms/userPermission?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "permissions": "string"
  }
]

GET/userPermission

Retrieve a user permission

Fetch a single user permission by filtering on `id`.

Query parameters

idstring

Match on the user permission's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/userPermission

curl --request GET \
  --url 'https://rest.carbon.ms/userPermission?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "permissions": "string"
}

POST/userPermission

Create a user permission

Create a new user permission.

Body parameters

permissionsobject

POSThttps://rest.carbon.ms/userPermission

curl --request POST \
  --url https://rest.carbon.ms/userPermission \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"id":"abc123def456"}'

Response

{
  "id": "abc123def456",
  "permissions": "string"
}

PATCH/userPermission

Update a user permission

Update an existing user permission, matched on `id`.

Body parameters

permissionsobject

PATCHhttps://rest.carbon.ms/userPermission

curl --request PATCH \
  --url 'https://rest.carbon.ms/userPermission?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"permissions":"string"}'

Response

{
  "id": "abc123def456",
  "permissions": "string"
}

DELETE/userPermission

Delete a user permission

Delete a user permission, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the user permission to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/userPermission

curl --request DELETE \
  --url 'https://rest.carbon.ms/userPermission?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content