Permissions | Struct Docs

Get all permissions added to the system

get

Authorizations

AuthorizationstringRequired

Responses

200

OK

application/json

get

/v1/permissions

GET /v1/permissions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "f81bbb84-c5a7-48bb-97c9-ea5225e6e53d",
    "PermissionGroupUid": "ad53d013-a9b2-4b28-89d8-f81b6368ffb3",
    "PermissionName": "Create products",
    "Description": "Permission required by users to be able to create new products",
    "IsSystemPermission": false
  },
  {
    "Uid": "c32a89bd-d385-4c58-8064-0c88e6edeca6",
    "PermissionGroupUid": "ad53d013-a9b2-4b28-89d8-f81b6368ffb3",
    "PermissionName": "Update products",
    "Description": "Permission required by users to be able to update products",
    "IsSystemPermission": false
  }
]

Add permission to system

post

Authorizations

AuthorizationstringRequired

Body

Representing a permission in the system

Uidstring · uuidOptional

Unique id of permission

PermissionGroupUidstring · uuidOptional

Uid of group to place permission in

PermissionNamestring | nullableOptional

Name of permission

Descriptionstring | nullableOptional

Description of permission

IsSystemPermissionbooleanOptional

Is system permission (readonly)

Responses

200

OK

No content

post

/v1/permissions

POST /v1/permissions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Uid": "6b6e769c-576c-420a-83b6-b9b0a27be82c",
  "PermissionGroupUid": "aa4e6808-5ff3-4a48-9aff-6bc57a7e40e2",
  "PermissionName": "Manage colors",
  "Description": "Allows users to manage values in the colors global list",
  "IsSystemPermission": false
}

200

OK

No content

Update a permission

put

Authorizations

AuthorizationstringRequired

Body

Representing a permission in the system

Uidstring · uuidOptional

Unique id of permission

PermissionGroupUidstring · uuidOptional

Uid of group to place permission in

PermissionNamestring | nullableOptional

Name of permission

Descriptionstring | nullableOptional

Description of permission

IsSystemPermissionbooleanOptional

Is system permission (readonly)

Responses

200

OK

No content

put

/v1/permissions

PUT /v1/permissions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Uid": "11308777-7bca-412a-a56d-1bebb68d6b91",
  "PermissionGroupUid": "c4087119-4a62-496c-9426-fc0a4d152a98",
  "PermissionName": "Manage colors",
  "Description": "Allows users to manage values in the colors global list",
  "IsSystemPermission": false
}

200

OK

No content

Get a specific permission

get

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Responses

200

OK

application/json

404

Not Found

application/json

get

/v1/permissions/{uid}

GET /v1/permissions/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "87aef2c9-2a4c-45f3-b489-b13f1bd0d956",
  "PermissionGroupUid": "92215ced-adef-4b03-b93a-5593dd647482",
  "PermissionName": "Create products",
  "Description": "Permission required by users to be able to create new products",
  "IsSystemPermission": false
}

Delete a permission

delete

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

the Unique id of the permission

Responses

200

OK

No content

delete

/v1/permissions/{uid}

DELETE /v1/permissions/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Get all permission groups added to the system

get

Authorizations

AuthorizationstringRequired

Responses

200

OK

application/json

get

/v1/permissiongroups

GET /v1/permissiongroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "32416003-8511-4213-bb91-1b409cdb6a7b",
    "Name": "Products",
    "IsSystemPermissionGroup": false
  },
  {
    "Uid": "892d4e10-cd48-4e63-a484-5efc23c3cc0a",
    "Name": "Variants",
    "IsSystemPermissionGroup": false
  }
]

Add permission group to system

post

Authorizations

AuthorizationstringRequired

Body

Represents a group of permissions

Uidstring · uuidOptional

Unique id of permission group

Namestring | nullableOptional

Name of permission group

IsSystemPermissionGroupbooleanOptional

Is system permission group (readonly)

Responses

200

OK

No content

post

/v1/permissiongroups

POST /v1/permissiongroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "Uid": "93afac58-f196-482a-9586-817098ed7388",
  "Name": "Global list permissions",
  "IsSystemPermissionGroup": false
}

200

OK

No content

Update a permission group

put

Authorizations

AuthorizationstringRequired

Body

Represents a group of permissions

Uidstring · uuidOptional

Unique id of permission group

Namestring | nullableOptional

Name of permission group

IsSystemPermissionGroupbooleanOptional

Is system permission group (readonly)

Responses

200

OK

No content

put

/v1/permissiongroups

PUT /v1/permissiongroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "Uid": "0134e7e1-bbaf-4858-834d-3f2a2c7b2602",
  "Name": "Global list permissions",
  "IsSystemPermissionGroup": false
}

200

OK

No content

Get a specific permission group

get

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Responses

200

OK

application/json

404

Not Found

application/json

get

/v1/permissiongroups/{uid}

GET /v1/permissiongroups/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "b20fbf01-e8aa-4140-98c5-8c919e355e1a",
  "Name": "Products",
  "IsSystemPermissionGroup": false
}

Delete a permission group

delete

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

The unique id of the permission group

Responses

200

OK

No content

delete

/v1/permissiongroups/{uid}

DELETE /v1/permissiongroups/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content