Roles

List available roles and permissions for the tenant

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/roles

Returns role definitions and associated permission.

Authorization

Requires tenant.access:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Roles returned.

text/plainapplication/jsontext/json

namestringRequired

permissionsstring[]Required

get/api/{tenantId}/admin/roles

HTTPcURLJavaScriptPython

GET /api/{tenantId}/admin/roles HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Roles returned.

[
  {
    "name": "text",
    "permissions": [
      "text"
    ]
  }
]

Create a new role

post

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/roles

Adds a new role entry to security.yml.

Authorization

Requires tenant.access.role:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Request body to create a role.

namestring · min: 1Required

Role name. Only alphanumeric characters, hyphens, underscores and dots are allowed. Cannot be "administrator".

permissionsstring[]Required

List of permission scopes granted to this role. Use ["*"] for full access.

Responses

201

Role created.

text/plainapplication/jsontext/json

namestringRequired

permissionsstring[]Required

400

Name is invalid or permissions are missing.

text/plainapplication/jsontext/json

409

A role with this name already exists, or the name is reserved.

text/plainapplication/jsontext/json

post/api/{tenantId}/admin/roles

HTTPcURLJavaScriptPython

POST /api/{tenantId}/admin/roles HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "name": "text",
  "permissions": [
    "text"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "permissions": [
    "text"
  ]
}

Get a specific role and permissions for the tenant

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/roles/{roleName}

Returns role definition and associated permissions for a single role.

Authorization

Requires tenant.access:read scope, or the caller must have the same role as roleName.

Path parameters

tenantIdstringRequired

roleNamestringRequired

Responses

200

Role returned.

text/plainapplication/jsontext/json

namestringRequired

permissionsstring[]Required

401

Caller not authorized.

text/plainapplication/jsontext/json

404

Role not found.

text/plainapplication/jsontext/json

get/api/{tenantId}/admin/roles/{roleName}

HTTPcURLJavaScriptPython

GET /api/{tenantId}/admin/roles/{roleName} HTTP/1.1
Host: app.neostore.cloud
Accept: */*

{
  "name": "text",
  "permissions": [
    "text"
  ]
}

Update a role's permissions

put

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/roles/{roleName}

Replaces the permission list of an existing role in security.yml. The "administrator" role cannot be modified.

Authorization

Requires tenant.access.role:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

roleNamestringRequired

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Request body to update a role's permissions.

permissionsstring[]Required

New list of permission scopes granted to this role. Use ["*"] for full access.

Responses

200

Role updated.

text/plainapplication/jsontext/json

namestringRequired

permissionsstring[]Required

400

Permissions are missing.

text/plainapplication/jsontext/json

404

Role not found.

text/plainapplication/jsontext/json

409

The role is the immutable "administrator" role.

text/plainapplication/jsontext/json

put/api/{tenantId}/admin/roles/{roleName}

HTTPcURLJavaScriptPython

PUT /api/{tenantId}/admin/roles/{roleName} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "permissions": [
    "text"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "permissions": [
    "text"
  ]
}

Delete a role

delete

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/roles/{roleName}

Removes a role from security.yml. The "administrator" role cannot be deleted.

Authorization

Requires tenant.access.role:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

roleNamestringRequired

tenantIdstringRequired

Responses

204

Role deleted.

No content

404

Role not found.

text/plainapplication/jsontext/json

409

The role is the immutable "administrator" role.

text/plainapplication/jsontext/json

delete/api/{tenantId}/admin/roles/{roleName}

HTTPcURLJavaScriptPython

DELETE /api/{tenantId}/admin/roles/{roleName} HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content