Skip to content

Latest commit

 

History

History
113 lines (67 loc) · 4.91 KB

ImplicitGrantsApi.md

File metadata and controls

113 lines (67 loc) · 4.91 KB
Raw

\ImplicitGrantsApi

All URIs are relative to http://localhost

Method HTTP request Description
create_implicit_grant POST /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/implicit_grants Create Implicit Grant
delete_implicit_grant DELETE /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/implicit_grants Delete Implicit Grant
update_implicit_grants_conditions PUT /v2/schema/{proj_id}/{env_id}/resources/{resource_id}/roles/{role_id}/implicit_grants/conditions Update Implicit Grants Conditions

create_implicit_grant

models::DerivedRoleRuleRead create_implicit_grant(proj_id, env_id, resource_id, role_id, derived_role_rule_create) Create Implicit Grant

Creates an implicit grant on a given role

Parameters

Name Type Description Required Notes
proj_id String Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). [required]
env_id String Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). [required]
resource_id String Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug"). [required]
role_id String Either the unique id of the role, or the URL-friendly key of the role (i.e: the "slug"). [required]
derived_role_rule_create DerivedRoleRuleCreate [required]

Return type

models::DerivedRoleRuleRead

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_implicit_grant

delete_implicit_grant(proj_id, env_id, role_id, resource_id, derived_role_rule_delete) Delete Implicit Grant

Deletes an implicit grant on a given role

Parameters

Name Type Description Required Notes
proj_id String Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). [required]
env_id String Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). [required]
role_id String Either the unique id of the role, or the URL-friendly key of the role (i.e: the "slug"). [required]
resource_id String Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug"). [required]
derived_role_rule_delete DerivedRoleRuleDelete [required]

Return type

(empty response body)

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_implicit_grants_conditions

models::DerivationSettings update_implicit_grants_conditions(proj_id, env_id, resource_id, role_id, derivation_settings) Update Implicit Grants Conditions

Update the when for implicit grants on a given role

Parameters

Name Type Description Required Notes
proj_id String Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). [required]
env_id String Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). [required]
resource_id String Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug"). [required]
role_id String Either the unique id of the role, or the URL-friendly key of the role (i.e: the "slug"). [required]
derivation_settings DerivationSettings [required]

Return type

models::DerivationSettings

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]