Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Implicit Grants

Create Implicit Grant

Creates an implicit grant on a given role

post/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/implicit_grants

Path parameters

resource_idstring required

Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug").

Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug").

role_idstring required

Either the unique id of the role, or the URL-friendly key of the role (i.e: the "slug").

Either the unique id of the role, or the URL-friendly key of the role (i.e: the "slug").

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Request body

rolestring required

the role key that needs to exist on the related resource (from the relation)

on_resourcestring required

the resource key that needs to exist on the related role (from the relation)

linked_by_relationstring required

the relation key that needs to exist between the resource and the related resource

Example request

{
  "role": "Admin",
  "on_resource": "organization",
  "linked_by_relation": "owner"
}

Response

Successful Response

role_idstring uuid required

the role id that needs to exist on the related resource (from the relation)

resource_idstring uuid required

the resource id that needs to exist on the related role (from the relation)

relation_idstring uuid required

the relation id that needs to exist between the resource and the related resource

rolestring required

the role key that needs to exist on the related resource (from the relation)

on_resourcestring required

the resource key that needs to exist on the related role (from the relation)

linked_by_relationstring required

the relation key that needs to exist between the resource and the related resource

Example response

{
  "role": "Admin",
  "on_resource": "organization",
  "linked_by_relation": "owner",
  "role_id": "4f9ad7ab-15bc-4e25-a5a5-57417b341719",
  "resource_id": "17dbf1da-4061-44a6-8f58-55719560f143",
  "relation_id": "534b2d8a-e8be-4039-828f-0607691ca48c"
}