Skip to content
StackTaktDocs

Update Tenant Group

PATCH
/identity/tenants/{tenant_id}/groups/{group_id}

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
group_id
required
Group Id
string format: uuid
tenant_id
required
Tenant Id
string format: uuid
Section titled “Cookie Parameters ”
st_session
Any of:
string

Request Body required

Section titled “Request Body required ”
GroupUpdateRequest
object
description
Any of:
string
<= 2000 characters
name
Any of:
string
>= 1 characters <= 120 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

TenantGroupDetail
object
built_in
required
Built In
boolean
description
required
Description
string
id
required
Id
string format: uuid
inherited
required
Inherited
boolean
member_count
required
Member Count
integer
members
required
Members
Array<object>
MemberRecord
object
email
required
Email
string
id
required
Id
string format: uuid
name
required
Name
string
organization_grants
required
Organization Grants
Array<object>
GrantRecord
object
created_at
required
Created At
string format: date-time
created_by
required
Created By
string
id
required
Id
string format: uuid
role_key
required
Role Key
string
role_name
required
Role Name
string
scope_type
required
Scope Type
string
tenant_aws_account_id
Any of:
string format: uuid
tenant_id
required
Any of:
string format: uuid
tenant_grants
required
Tenant Grants
Array<object>
GrantRecord
object
created_at
required
Created At
string format: date-time
created_by
required
Created By
string
id
required
Id
string format: uuid
role_key
required
Role Key
string
role_name
required
Role Name
string
scope_type
required
Scope Type
string
tenant_aws_account_id
Any of:
string format: uuid
tenant_id
required
Any of:
string format: uuid

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string