Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Charthop role API

The role API from Charthop — 4 operation(s) for role.

Charthop role API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include role. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 21 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

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

7 operations 4 paths 21 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
Resource Areas
1

Paths & Operations 7

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

role 7
GET
/v1/org/{orgId}/role
Return all or a set of roles in the organization
findRoles 4 params → 200400401404
POST
/v1/org/{orgId}/role
Create a role
createRole 2 params → 201400401403404
POST
/v1/org/{orgId}/role/export
Export roles to CSV format
exportRoles 1 param → 201401403404
GET
/v1/org/{orgId}/role/{roleId}
Return a particular role by id
getRole 3 params → 200400404
PATCH
/v1/org/{orgId}/role/{roleId}
Update an existing role
updateRole 3 params → 204400401403404
DELETE
/v1/org/{orgId}/role/{roleId}
Delete a role
deleteRole 2 params → 200400401404500
POST
/v1/org/{orgId}/role/{roleId}/copy
Copy an existing role
copyRole 2 params → 201400401403404

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are User (35 properties), Process (29 properties), Role (14 properties), AiAgentConfig (14 properties). Each schema is shown below with its type and property counts.

LogData
object
4 properties 3 required
OrgAccess
object
11 properties 2 required
TargetedInstruction
object
2 properties 2 required
PolicyRuleTarget
object
4 properties
Role
object
14 properties 2 required
User
object
35 properties 2 required
AiAgentConfig
object
14 properties
BundleInstallEntity
object
3 properties 3 required
Process
object
29 properties 9 required
ResultsRole
object
2 properties 1 required
Attribution
object
6 properties
BundleInstall
object
1 property 1 required
CreateRole
object
4 properties 1 required
Policy
object
14 properties 2 required
UpdateRole
object
3 properties
MessagingConfig
object
3 properties
WebRegisteredCredential
object
5 properties 5 required
UserEmailSetting
object
2 properties 2 required
ShareAccess
object
4 properties 1 required
PolicyRule
object
11 properties
Name
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-role-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
Charthop action API
Charthop ai API
Charthop ai-credit-limit API
Charthop ai-hint API
Charthop ai-prompt API
Charthop app API
Charthop appConfig API
Charthop approval API
Charthop approval-delegate API
Charthop approval-request API
Charthop assessment API