How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Openpath orgs/roles API

User Roles

Openpath orgs/roles API is one of 89 APIs that Openpath publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include orgs/roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 13 operations across 7 paths. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://api.openpath.com.

13 operations 7 paths 0 schemas 2 DELETE4 GET2 PATCH1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://api.openpath.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Openpath orgs/roles API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (jwt).

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 2 DELETE, 4 GET, 2 PATCH, 1 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

orgs/roles 13

User Roles

GET
/orgs/{orgId}/roles
List all roles
listRoles 8 params → 200
POST
/orgs/{orgId}/roles
Create a role
createRole 2 params → 201
GET
/orgs/{orgId}/roles/{roleId}
Describe a role
describeRole 2 params → 200
DELETE
/orgs/{orgId}/roles/{roleId}
Delete a role
deleteRole 2 params → 204
PATCH
/orgs/{orgId}/roles/{roleId}
Update a role
updateRole 3 params → 204
GET
/orgs/{orgId}/roles/{roleId}/users
List all users of a role
listRoleUsers 10 params → 200
GET
/orgs/{orgId}/roles/{roleId}/scopeIds
List all scope ids of a role
listRoleScopeIds 2 params → 200
PUT
/orgs/{orgId}/roles/{roleId}/scopeIds
Set a role's scopes by replacing the entire set with this one
setRoleScopeIds 3 params → 204
DELETE
/orgs/{orgId}/roles/{roleId}/users/{userId}
Remove a user from a role
removeUserFromRole 3 params → 204
PUT
/orgs/{orgId}/roles/{roleId}/users/{userId}
Add a user to a role
setUserToRole 3 params → 204
PATCH
/orgs/{orgId}/roles/{roleId}/userIds
Bulk-update a role's users
updateRoleUserIds 3 params → 204
PUT
/orgs/{orgId}/roles/{roleId}/userIds
Set a role's users by replacing the entire set with this one
setRoleUserIds 3 params → 204
PUT
/orgs/{orgId}/roles/{roleId}/siteIds
Set a role's sites by replacing the entire set with this one
setRoleSiteIds 3 params → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openpath-orgs-roles-api-openapi.yml Raw ↑

Other APIs Openpath publishes across the network.

Openpath auth API
Openpath billableFeatures API
Openpath identities API
Openpath orgs/acuModels API
Openpath orgs/acuPorts API
Openpath orgs/acuPortTypes API
Openpath orgs/acus API
Openpath orgs/alarmActions API
Openpath orgs/alarmConfigurations API
Openpath orgs/alarmSeverities API
Openpath orgs/alarmsExt API
Openpath orgs/alarmStatuses API
Where this information came from

This is an independent, third-party profile of Openpath orgs/roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.