Request

Response

    Create User Group User
    POST

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

    Creates a new User Group User membership in a specific group.

    userId must be an Autodesk Forma account-user UUID. It is validated against Autodesk Forma, and membershipType (default USER) determines how: a USER member is looked up as a hub user; ROLE / COMPANY members are validated against Autodesk Forma and must currently be active, otherwise the request is rejected with 400.

    Mutating the hub’s admin group (groupId equal to hubId) is not allowed and returns 403; its membership is derived from Autodesk Forma, not stored here.

    Resource Information

    Method and URI
    POST
    https://api.aps.autodesk.com/content-catalog/v2/hubs/{hubId}/groups/{groupId}/users
    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
    * Required

    Request

    URI Parameters

    hubId
    string
    Hub ID that owns the user group user membership
    groupId
    string
    Group ID to add the user to

    Request

    Body Structure

    User Group User membership to create

    userId*
    string
    Autodesk Forma account-user UUID (uppercase, 8-4-4-4-12 hex digits).
    membershipType
    enum:string
    Membership type discriminator (USER, COMPANY, or ROLE). Defaults to USER. Possible values: USER, COMPANY, ROLE
    * Required

    Response

    HTTP Status Code Summary

    201
    Created
    User Group User membership successfully created
    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.
    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 was unavailable. On POST/PATCH for a ROLE/COMPANY member, this means the Autodesk Forma call used to validate the member identifier failed (5xx) or was rate-limited (429). On any operation, it can also mean DynamoDB was throttled. Retry after a short delay.

    Response

    Body Structure (201)

    userId
    string
    The member’s Autodesk Forma account-user UUID (uppercase). For a COMPANY or ROLE member this is the company/role UUID.
    userGroupId
    string
    Group ID that the user belongs to
    hubId
    string
    Unique identifier of the hub that owns this membership
    membershipType
    enum:string
    Membership type discriminator - indicates the type of member (USER, COMPANY, or ROLE) Possible values: USER, COMPANY, ROLE

    Example

    User Group User membership successfully created

    Request

    curl -v 'https://developer.api.autodesk.com/content-catalog/v2/hubs/757FF58F-AE23-42D8-B303-BD7B53FA2B98/groups/6A10A175-3374-4586-BADB-182D40747ECC/users' \
      -X 'POST' \
      -H 'Authorization: ' \
      -H 'Content-Type: application/json' \
      -d '{
            "userId": "012C79A6-8C01-4502-86C2-32264EC81207",
            "membershipType": "USER"
          }'
    
    Show More

    Response

    {
      "userId": "012C79A6-8C01-4502-86C2-32264EC81207",
      "userGroupId": "6A10A175-3374-4586-BADB-182D40747ECC",
      "hubId": "757FF58F-AE23-42D8-B303-BD7B53FA2B98",
      "membershipType": "USER"
    }