group
Perform a Patch on a group by name
- Blog
- FAQ
- Product Demos
- API Guide
- GETGet an agent by name
- DELDelete an agent by name
- PATCHPerform a Patch on an agent by name
- GETQuery agent health
- GETGet all agents
- POSTCreate an agent
- POSTGet all agents based on a query
- GETGet the access report for an agent by name
- GETGet available permissions for an agent
- GETGet an audit context by name
- PATCHPerform a Patch on an audit context by name
- GETGet all audit contexts
- POSTCreate an audit context
- POSTGet all audit contexts based on a query
- GETGet the access report for an audit context by name
- GETGet available permissions for an audit context
- GETGet a cloud account by name
- DELDelete an cloud account by name
- PATCHPerform a Patch on a cloud account by name
- GETGet all cloud accounts
- POSTCreate a cloud account
- POSTGet all cloud accounts based on a query
- GETGet the access report for a cloud account by name
- GETGet available permissions for a cloud account resource type
- GETGet a domain by name
- DELDelete a domain by name
- PATCHPerform a Patch on a domain by name
- GETGet all domains
- POSTCreate a domain
- POSTGet all domains based on a query
- GETGet the access report for a domain by name
- GETGet available permissions for a domain resource type
- GETGet a group by name
- DELDelete a group by name
- PATCHPerform a Patch on a group by name
- GETGet all groups
- POSTCreate a group
- POSTGet all groups based on a query
- GETGet the access report for a group by name
- GETGet available permissions for a group resource type
- GETGet a GVC by name
- DELDelete a GVC by name
- PATCHPerform a Patch on a GVC by name
- GETGet all GVCs
- POSTCreate a GVC
- POSTGet all GVCs based on a query
- GETGet the access report for a GVC by name
- GETGet available permissions for a GVC resource type
- GETGet an identity by GVC and name
- DELDelete an identity by GVC and name
- PATCHPerform a Patch on an identity by name
- GETGet all identities in a GVC
- POSTCreate an identity
- GETGet all identities from all GVCs
- POSTGet all GVC identities based on a query
- GETGet the access report for an identity by GVC and name
- GETGet available permissions for an identity
- GETGet a image by name
- DELDelete an image by name
- PATCHPerform a Patch on an image by name
- GETGet all images
- POSTGet all images based on a query
- GETGet the access report for an image by name
- GETGet available permissions for an image resource type
- GETGet a location by name
- PATCHPerform a Patch on a location by name
- GETGet all locations
- POSTGet all locations based on a query
- GETGet the access report for a location by name
- GETGet available permissions for a location resource type
- GETGet an org by name
- PATCHPerform a Patch on an org by name
- GETGet all orgs
- POSTCreate an org
- POSTGet all orgs based on a query
- GETGet the access report for an org by name
- GETGet available permissions for an org resource type
- GETGet a policy by name
- DELDelete a policy by name
- PATCHPerform a Patch on a policy by name
- GETGet all policies
- POSTCreate a policy
- POSTGet all policies based on a query
- GETGet the access report for a policy by name
- GETGet available permissions for a policy resource type
- GETGet a quota by ID
- GETGet all quotas
- POSTGet all quotas based on a query
- GETGet available permissions for a quota resource type
- GETGet a secret by name
- DELDelete a secret by name
- PATCHPerform a Patch on a secret by name
- GETGet all secrets
- POSTCreate a secret
- GETGet the sensitive content of a secret by name
- POSTGet all secrets based on a query
- GETGet the access report for a secret by name
- GETGet available permissions for a secret resource type
- GETGet a service account by name
- DELDelete a service account by name
- PATCHPerform a Patch on a service account by name
- GETGet all service accounts
- POSTCreate a service account
- POSTGet all service accounts based on a query
- GETGet the access report for a service account by name
- POSTAdd a key to a service account
- GETGet available permissions for a service account resource type
- GETList tasks that you can accept to refuse
- GETList tasks that you can accept to refuse in a specific org
- GETGet a task by ID
- POSTPost
- DELDelete/Cancel a task by ID
- GETGet all tasks
- POSTGet all tasks based on a query
- GETGet available permissions for a task resource type
- GETGet a user by name
- DELDelete a user by name
- PATCHPerform a Patch on a user by name
- GETGet all users
- POSTGet all users based on a query
- POSTInvite users to this org
- GETGet the access report for a user by name
- GETGet available permissions for a user resource type
- GETGet a volumeset by GVC and name
- DELDelete a volumeset by name
- PATCHPerform a Patch on a volumeset by name
- GETList volumesets in a GVC you are authorized to view
- POSTCreate a volumeset
- GETGet all volumesets
- POSTGet all volumesets based on a query
- GETGet the access report for a volumeset by GVC and name
- GETGet available permissions for a volumeset resource type
- GETGet a workload by GVC and name
- DELDelete a workload by name
- PATCHPerform a Patch on a workload by name
- GETGet a deployment by GVC, workload and name
- GETList workloads in a GVC you are authorized to view
- POSTCreate a workload
- GETGet all workloads
- GETList deployments in a workload
- POSTGet all workloads based on a query
- GETGet the access report for a workload by GVC and name
- GETGet available permissions for a workload resource type
Overview
agent
auditctx
cloudaccount
domain
group
gvc
identity
image
location
org
policy
quota
secret
serviceaccount
task
user
volumeset
workload
group
Perform a Patch on a group by name
PATCH
/
org
/
{org}
/
group
/
{name}
Authorization
string
*
Authorization
Required
string
Service account key can be used as API keys
org
string
*
org
Required
string
name
string
*
name
Required
string
object
$drop
array
$drop
array
description
string
description
string
tags
object
tags
object
$replace/tags
object
$replace/tags
object
memberLinks
array
memberLinks
array
$drop/memberLinks
array
$drop/memberLinks
array
$append/memberLinks
array
$append/memberLinks
array
$retain/memberLinks
array
$retain/memberLinks
array
memberQuery
object
memberQuery
object
$drop
array
$drop
array
kind
string
kind
string
spec
object
spec
object
$drop
array
$drop
array
match
enum<string>
match
enum<string>
terms
array
terms
array
$drop/terms
array
$drop/terms
array
$append/terms
array
$append/terms
array
$patch/terms
array
$patch/terms
array
$retain/terms
array
$retain/terms
array
$replace/spec
object
$replace/spec
object
match
enum<string>
match
enum<string>
terms
array
terms
array
$replace/memberQuery
object
$replace/memberQuery
object
kind
string
kind
string
spec
object
spec
object
match
enum<string>
match
enum<string>
terms
array
terms
array
identityMatcher
object
identityMatcher
object
$drop
array
$drop
array
expression
string
expression
string
language
enum<string>
language
enum<string>
$replace/identityMatcher
object
$replace/identityMatcher
object
expression
string
expression
string
language
enum<string>
language
enum<string>
Authorizations
Authorization
string
headerrequiredService account key can be used as API keys
Path Parameters
org
string
requiredname
string
requiredBody
application/json
$drop
enum<string>[]
Available options:
description, tags, memberLinks, memberQuery, identityMatcher description
string
tags
object
$replace/tags
object
memberLinks
string[]
$drop/memberLinks
string[]
$append/memberLinks
string[]
$retain/memberLinks
string[]
memberQuery
object
memberQuery.$drop
enum<string>[]
Available options:
kind, spec memberQuery.kind
string
memberQuery.spec
object
memberQuery.spec.$drop
enum<string>[]
Available options:
match, terms memberQuery.spec.match
enum<string>
default: allAvailable options:
all, any, none memberQuery.spec.terms
object[]
memberQuery.spec.terms.op
enum<string>
default: =Available options:
=, >, >=, <, <=, !=, ~, exists, !exists memberQuery.spec.terms.property
string
memberQuery.spec.terms.rel
string
memberQuery.spec.terms.tag
string
memberQuery.spec.terms.value
memberQuery.spec.$drop/terms
string[]
memberQuery.spec.$append/terms
object[]
memberQuery.spec.$append/terms.op
enum<string>
default: =Available options:
=, >, >=, <, <=, !=, ~, exists, !exists memberQuery.spec.$append/terms.property
string
memberQuery.spec.$append/terms.rel
string
memberQuery.spec.$append/terms.tag
string
memberQuery.spec.$append/terms.value
memberQuery.spec.$patch/terms
object[]
memberQuery.spec.$patch/terms.$drop
enum<string>[]
Available options:
op, property, rel, tag, value memberQuery.spec.$patch/terms.op
enum<string>
default: =Available options:
=, >, >=, <, <=, !=, ~, exists, !exists memberQuery.spec.$patch/terms.property
string
memberQuery.spec.$patch/terms.rel
string
memberQuery.spec.$patch/terms.tag
string
memberQuery.spec.$patch/terms.$replace/value
memberQuery.spec.$patch/terms.value
any
memberQuery.spec.$retain/terms
string[]
memberQuery.$replace/spec
object
memberQuery.$replace/spec.match
enum<string>
default: allAvailable options:
all, any, none memberQuery.$replace/spec.terms
object[]
memberQuery.$replace/spec.terms.op
enum<string>
default: =Available options:
=, >, >=, <, <=, !=, ~, exists, !exists memberQuery.$replace/spec.terms.property
string
memberQuery.$replace/spec.terms.rel
string
memberQuery.$replace/spec.terms.tag
string
memberQuery.$replace/spec.terms.value
$replace/memberQuery
object
$replace/memberQuery.kind
string
$replace/memberQuery.spec
object
$replace/memberQuery.spec.match
enum<string>
default: allAvailable options:
all, any, none $replace/memberQuery.spec.terms
object[]
$replace/memberQuery.spec.terms.op
enum<string>
default: =Available options:
=, >, >=, <, <=, !=, ~, exists, !exists $replace/memberQuery.spec.terms.property
string
$replace/memberQuery.spec.terms.rel
string
$replace/memberQuery.spec.terms.tag
string
$replace/memberQuery.spec.terms.value
identityMatcher
object
identityMatcher.$drop
enum<string>[]
Available options:
expression, language identityMatcher.expression
string
identityMatcher.language
enum<string>
default: jmespathAvailable options:
jmespath, javascript $replace/identityMatcher
object
$replace/identityMatcher.expression
string
$replace/identityMatcher.language
enum<string>
default: jmespathAvailable options:
jmespath, javascript Response
200 - application/json
id
string
name
string
kind
string
version
integer
description
string
tags
object
created
string
lastModified
string
links
object[]
links.rel
string
links.href
string
memberLinks
string[]
memberQuery
object
memberQuery.kind
string
memberQuery.context
object
memberQuery.spec
object
memberQuery.spec.match
enum<string>
default: allAvailable options:
all, any, none memberQuery.spec.terms
object[]
memberQuery.spec.terms.op
enum<string>
default: =Available options:
=, >, >=, <, <=, !=, ~, exists, !exists memberQuery.spec.terms.property
string
memberQuery.spec.terms.rel
string
memberQuery.spec.terms.tag
string
memberQuery.spec.terms.value
identityMatcher
object
identityMatcher.expression
string
identityMatcher.language
enum<string>
default: jmespathAvailable options:
jmespath, javascript origin
enum<string>
default: defaultAvailable options:
synthetic, default, builtin