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

Amigo Role API

The Role API from Amigo — 5 operation(s) for role.

Amigo Role API is one of 72 APIs that Amigo 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 6 operations across 5 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 5 base URLs: https://api.amigo.ai, https://internal-api.amigo.ai, https://api-eu-central-1.amigo.ai, https://api-ap-southeast-2.amigo.ai, https://api-ca-central-1.amigo.ai.

6 operations 5 paths 25 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.amigo.ai
Authentication
HTTP Bearer, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 3

Amigo Role API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer-Authorization). An API key is passed in the header as X-ORG-ID (Bearer-Authorization-Organization). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • Bearer-Authorization — Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the [SignInWithAPIKey](sign-in-wi…
  • Bearer-Authorization-Organization — An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is ma…
  • Basic — The username should be set to {orgid}{userid}, and the password should be the Amigo issued JWT token that identifies the user.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Role 6
POST
/v1/{organization}/role/temporary_permission_grant/
Create a temporary permission grant
create-temporary-permission-grant 3 params body → 201404422401403503429
GET
/v1/{organization}/role/temporary_permission_grants/
Get temporary permission grants
get-temporary-permission-grants 12 params → 200404422401403503429
POST
/v1/{organization}/role/
Create a role
create-role 3 params body → 201409404422401403503429
GET
/v1/{organization}/role/
Get roles
get_roles_v1__organization__role__get 6 params → 200404422401403503429
POST
/v1/{organization}/role/{role_name}
Modify a role
modify-role 4 params body → 200404400422401403503429
POST
/v1/{organization}/role/{role_name}/assign
Assign a role to user
assign-role 4 params body → 200404422401403503429

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are TemporaryPermissionGrant (10 properties), src__app__endpoints__role__create_temporary_permission_grant__Request (5 properties), RoleInstance (5 properties), src__app__endpoints__role__create_role__Request (4 properties). Each schema is shown below with its type and property counts.

Condition
EqualCondition
object
Requires that the attribute value in the request to be equal to a specific value.
2 properties 1 required
amigo_lib__pydantic__base_model__StrippedNonemptyString__5
string
NotEqualCondition
object
Requires that the attribute value in the request to be not equal to a specific value.
2 properties 1 required
amigo_lib__mongo__collections__temporary_permission_grant__TemporaryPermissionGrant__UserInfo
object
2 properties 2 required
PermissionGrantInstance
object
2 properties 2 required
RoleInstance
object
5 properties 5 required
src__app__endpoints__role__get_temporary_permission_grants__Response
object
3 properties 3 required
StrippedNonemptyString___w__s_____
string
src__app__endpoints__role__create_role__Response
object
1 property 1 required
src__app__endpoints__role__get_roles__Response
object
1 property 1 required
PermissionGrant-Output
object
2 properties 2 required
InCondition
object
Requires that the attribute value in the request to be one of the specified values.
2 properties 1 required
src__app__endpoints__role__create_temporary_permission_grant__Request
object
5 properties 5 required
src__app__endpoints__role__assign_role__Response
object
1 property 1 required
src__app__endpoints__role__create_role__Request
object
4 properties 4 required
src__app__endpoints__role__assign_role__Request
object
1 property 1 required
src__app__endpoints__role__modify_role__Request
object
3 properties
src__app__endpoints__role__create_temporary_permission_grant__Response
object
2 properties 2 required
amigo_lib__pydantic__base_model__StrippedNonemptyString__1
string
TemporaryPermissionGrant
object
A temporary permission grant provides an user additional permission grants beyond what their role allows for a limited amount of time.
10 properties 8 required
PermissionGrant-Input
object
2 properties 2 required
src__app__endpoints__role__modify_role__Response
object
1 property 1 required
FrontendView
string
amigo_lib__pydantic__base_model__StrippedNonemptyString__2
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-role-api-openapi.yml Raw ↑

Other APIs Amigo publishes across the network.

Amigo Account API
Amigo Admin API
Amigo Agent Definitions API
Amigo Agent Runs API
Amigo Agents API
Amigo Analytics API
Amigo API Keys API
Amigo Audit API
Amigo Auth API
Amigo Billing API
Amigo Calls API
Amigo Command Center API
Where this information came from

This is an independent, third-party profile of Amigo Role 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.