Boundary Controller HTTP API
Role Service
Lists all Roles.
Query Parameters
scope_id string recursive boolean filter string list_token string An opaque token used to continue an existing iteration or request updated items. If not specified, pagination will start from the beginning.
page_size integer The maximum size of a page in this iteration. If unset, the default page size configured will be used. If the page_size is greater than the default page configured, an error will be returned.
Creates a single Role.
Body Parameters
scope_id string The ID of the Scope containing this Role.
name string Optional name for identification purposes.
description string Optional user-set description for identification purposes.
version integer Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
grant_scope_id string The Scope the grants will apply to. If the Role is at the global scope, this can be an org or project. If the Role is at an org scope, this can be a project within the org. It is invalid for this to be anything other than the Role's scope when the Role's scope is a project.
Deprecated: Use "grant_scope_ids" instead.
Gets a single Role.
Path Parameters
id string RequiredDeletes a Role.
Path Parameters
id string RequiredUpdates a Role.
Path Parameters
id string RequiredBody Parameters
scope_id string The ID of the Scope containing this Role.
name string Optional name for identification purposes.
description string Optional user-set description for identification purposes.
version integer Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
grant_scope_id string The Scope the grants will apply to. If the Role is at the global scope, this can be an org or project. If the Role is at an org scope, this can be a project within the org. It is invalid for this to be anything other than the Role's scope when the Role's scope is a project.
Deprecated: Use "grant_scope_ids" instead.
Adds grant scopes to a Role
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
grant_scope_ids string[] Adds grants to a Role
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
grant_strings string[] Adds Users and/or Groups to a Role.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
principal_ids string[] Removes grant scopes from a Role.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
grant_scope_ids string[] Removes grants from a Role.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
grant_strings string[] Removes the specified Users and/or Groups from a Role.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
principal_ids string[] Set grant scopes for a Role, removing any grant scopes that are not specified in the request.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
grant_scope_ids string[] Set grants for a Role, removing any grants that are not specified in the request.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
grant_strings string[] Set Users and/or Groups to a Role, removing any principals that are not specified in the request.
Path Parameters
id string RequiredBody Parameters
version integer Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.
principal_ids string[]