Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Overview
API Reference Overview
How to use the API 'Try It' feature
Authentication And Authorization (AAA) Service
Role Management
User Management
Authentication
Connection Management
Group Management
Participant Service
Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
Participant Type - State Machine
Participant
Templates
Participant State
Participant - Batch Processing
Container Service
Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
Container Type - State Machine Config
Container
Container State
Container Group
Container - Batch Processing
Dispatch Service
Job Type
Job Workflow
Job
Job - Config
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
Ledger
Ledger in batch
Custom Code Config
Workflow Service
Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
SDS Service
App
Vault
Data
File Management Service
Folders
Files
State Machine Service
State Machine Config
Entity
Events
Reasons
Instance State
Movement Tracking Service
Trace Data
Missing Sequence Numbers
Snapped Distance
IOT Device
Geofence
MTS Subscription
Entity Service
Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
Templates
Entity - Batch Processing
Notification Service
App Notification
Filter
Event
Change Log
Location Service
Location
Country
State
City
Search
Order Service
Order Config
Order State Machine Configuration
Order State Machine Transition
Work Order State Machine Configuration
Work Order State Transition
Order
Batch Order
Custom Code Config
Plugin Callback
External Reference APIs
Work Order Config
Work Order Status
Plugins
PluginWorkflow
Address Service
Address Config
Address
User FPA
Users
Facility FPA
Facilities
Vehicle FPA
Vehicles
LogisticsOrder API
Order
Batch Order
AAA - External Authorizer
Authorization
Orchestrator
Plugins
PluginWorkflow
Rules
Get Entity Status
DLQ Service
Query & Listing
Default Plugins
Job Manager
Work Order Manager
Container Manager
Workflow Manager
Cancellation Manager
Scheduler Service
Scheduler Service
Docs powered by Archbee
Authentication And Authorizati...
Role Management

Create App Role

1min
POST
https://{tenantSubdomain}.getos1.com/core/api/v1/aaa/apps/{appId}/roles
This endpoint creates an App Role. Role is a generic representation of a set of permissions or resources of a specific app or service. Please note that requests that exceed the 375KB size limit will be rejected. Avoid passing large payloads to prevent exceeding this limit.
PATH PARAMETERS
appId
string
*
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*
Unique request ID
X-COREOS-ACCESS
string
*

Core-os access token

X-COREOS-AUTH
string

Core-os authentication token.

X-COREOS-USERINFO
string
User info
X-COREOS-TID
string
*
Tenant ID
BODY PARAMETERS
body
RoleCreateRequest
*
roleName
string
*
Name of the role (each role should be assigned with a name).
description
string
*
Description of the role, for example, role created for admin users.
securityLevel
string<SENSITIVE | RESTRICTED | OPEN>
Security level of the the role. Default is OPEN. Used to restrict the access level for the role.
permissions
string[]
Permissions attached with the role.
canGrantToApps
boolean
Boolean value indicates if the role can be granted to other apps/services.
canGrantToUsers
boolean
Boolean value indicates if the Role can be granted to user groups.
RESPONSES
201
OK - The request succeeded.
SuccessResponse
[All Of:ErrorResponseobject]
error
Error
Information of error occurred during operation.
request
Request
data
object
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
Information of error occurred during operation.
request
Request
401
Unauthorized - The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
Information of error occurred during operation.
request
Request
403
Forbidden - The client's identity is known to the server but it does not have access rights to the requested resource. Verify that you're using the correct client ID and client secret or grant the client the necessary roles to access the resource.
ErrorResponse
error
Error
Information of error occurred during operation.
request
Request
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
Information of error occurred during operation.
request
Request
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
Information of error occurred during operation.
request
Request




Updated 30 Oct 2023
Did this page help you?
PREVIOUS
How to use the API 'Try It' feature
NEXT
Get all Roles
Docs powered by Archbee