Update users mapping for a Group. Please note that requests that exceed the 375KB size limit will be rejected. Avoid passing large payloads to prevent exceeding this limit.

1min
PUT
https://{tenantSubdomain}.getos1.com/core/api/v1/aaa/groups/{groupId}/users
This endpoint updates the User mapping for a Group membership. Default value: true. membership=true => Add specified Users to the Group; membership=false => remove specified Users from Group.
Path Parameters
groupId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-AUTH
string
X-COREOS-TID
string
*
X-COREOS-USERINFO
string
Body Parameters
body
GroupUsersMappingUpdateRequest
*
users
string[]
*
membership
boolean
Responses
200
OK - The request succeeded.
SuccessResponse
All Of
ErrorResponse  +
error
Error
request
Request
data
object
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
request
Request
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
request
Request
403
Forbidden - The client's identity is known to the server but it does not have access rights to the requested resource. Verify that you're using the correct client ID and client secret or grant the client the necessary roles to access the resource.
ErrorResponse
error
Error
request
Request
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
request
Request
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}.getos1.com/core/api/v1/aaa/groups/{groupId}/users' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "users": [
    ""
  ]
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.getos1.com/core/api/v1/aaa/groups/{groupId}/users' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "users": [
    ""
  ]
}'
Responses
200
400
401
403
404
503
// OK - The request succeeded. 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {
      "errorTrace": [
        {}
      ],
      "id": ""
    }
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK - The request succeeded. 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {
      "errorTrace": [
        {}
      ],
      "id": ""
    }
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿
Updated 30 Oct 2023
Did this page help you?
Get Groups
Get all users in a Group