Request

Response

    Update User Group
    PATCH

    v2/hubs/{hubId}/groups/{groupId}

    Partially updates an existing User Group in a hub using JSON Patch standard (RFC 6902). Only the replace operation is supported, and only for the /name and /pinnedCollections paths.

    The hub’s admin group (ID equal to hubId) can be patched, but only /pinnedCollections.

    Resource Information

    Method and URI
    PATCH
    https://api.aps.autodesk.com/content-catalog/v2/hubs/{hubId}/groups/{groupId}
    Authentication Context
    user context required
    Required OAuth Scopes
    data:write
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account flow.

    The Secure Service Account (SSA) flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    Region
    string
    Region identifier for API routing. Defaults to US if not provided.
    Content-Type*
    string
    Must be application/json-patch+json
    * Required

    Request

    URI Parameters

    hubId
    string: UUID
    Hub ID that owns the user group
    groupId
    string: UUID
    Unique identifier of the user group

    Request

    Body Structure

    JSON Patch operations to apply

    op*
    enum:string
    The operation to perform. Only replace is supported for user groups. Will always be: replace
    path*
    string
    JSON Pointer to the target field. Only /name and /pinnedCollections can be changed.
    value
    object
    The value to use for the operation.
    * Required

    Response

    HTTP Status Code Summary

    200
    OK
    User Group successfully updated
    400
    Bad Request
    The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request.
    401
    Unauthorized
    The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
    403
    Forbidden
    The request was successfully validated, but lacking the required permissions. Verify your credentials and permissions before you send the request again.
    404
    Not Found
    The requested resource was not found. Review the request and try again.
    500
    Internal Server Error
    An unexpected error occurred on the server, preventing it from completing your request. Please try again later. If the issue persists, contact the support team for assistance.
    503
    Service Unavailable
    The request could not be completed because a downstream dependency (DynamoDB) was throttled or temporarily unavailable. Retry after a short delay.

    Response

    Body Structure (200)

    id
    string: UUID
    Unique identifier of the user group
    hubId
    string: UUID
    Unique identifier of the hub that owns this group
    name
    string
    User Group name
    createdAt
    datetime: ISO 8601
    Creation timestamp
    createdBy
    string
    Creator identifier (Autodesk ID)
    updatedAt
    datetime: ISO 8601
    Last update timestamp
    updatedBy
    string
    Last modifier identifier (Autodesk ID)
    isAdminGroup
    boolean
    Read-only computed field. True when this group is the hub’s admin group (i.e., the group ID equals “{hubId}” — the same UUID as the hub).
    pinnedCollections
    array: string
    List of pinned collection IDs

    Example

    User Group successfully updated

    Request

    curl -v 'https://developer.api.autodesk.com/content-catalog/v2/hubs/757FF58F-AE23-42D8-B303-BD7B53FA2B98/groups/6A10A175-3374-4586-BADB-182D40747ECC' \
      -X 'PATCH' \
      -H 'Authorization: ' \
      -H 'Content-Type: application/json-patch+json' \
      -d '[
            {
              "op": "replace",
              "path": "/name",
              "value": "Engineering Team"
            }
          ]'
    
    Show More

    Response

    {
      "id": "6A10A175-3374-4586-BADB-182D40747ECC",
      "hubId": "757FF58F-AE23-42D8-B303-BD7B53FA2B98",
      "name": "Engineering Team",
      "createdAt": "2024-01-15T10:30:00Z",
      "createdBy": "AKB2JV55N3SQ55DT",
      "updatedAt": "2024-01-16T14:20:00Z",
      "updatedBy": "AKB2JV55N3SQ55DT",
      "isAdminGroup": false,
      "pinnedCollections": [
        "555B69AF-140E-48C3-A21E-C9D18575954B"
      ]
    }
    
    Show More