Request

Response

    Add Team User
    POST

    teams/{team-id}/users

    Invites a user to the team and adds them to it. When the email address does not belong to an existing Autodesk account, the supplied name is used to create the invitation. The team determines whether the user has the USER or EXTERNAL_USER role. If the user is already on the team, the existing user is returned and no new invitation is sent.

    Invited users who create a new Autodesk account are redirected to an Autodesk-managed page after registration; you don’t supply a return URL.

    This operation adds standard or external users only. Removing a user from a team is not supported.

    This operation shares the team’s allowance of 60 calls per UTC minute with all other team-specific operations.

    Resource Information

    Method and URI
    POST
    https://developer.api.autodesk.com/team-admin/v1/teams/{team-id}/users
    Authentication Context
    User-delegated only (accepts only three-legged access tokens)
    Required OAuth Scopes
    tmadmapi:team-users:write tmadmapi:team: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.
    X-Request-Id
    string
    An optional identifier used to trace the API request across services and logs. Accepts 1–128 ASCII letters, digits, periods, underscores, or hyphens. Leading and trailing whitespace is removed. Valid identifiers are returned in the X-Request-Id response header. If omitted or invalid, a new identifier is generated. The header may be absent from some error responses.
    Content-Type*
    string
    Must be application/json
    * Required

    Request

    URI Parameters

    team-id
    string
    The ID of the team on which to perform this operation. Use the id value returned by the List Teams operation.

    Request

    Body Structure

    email*
    string
    The email address of the user to invite and add.

    Max length: 200

    firstName
    string
    The given name of the user. Used only when the email address does not belong to an existing Autodesk account.

    Max length: 75

    lastName
    string
    The family name of the user. Used only when the email address does not belong to an existing Autodesk account.

    Max length: 75

    * Required

    Response

    HTTP Status Code Summary

    200
    OK
    The user is already on the team. The existing user was successfully retrieved, and no new invitation was sent.
    201
    Created
    The user was successfully added to the team. The invitation may still be pending acceptance.
    400
    Bad Request
    The request could not be processed due to invalid or malformed data. Check the request parameters, body format, required fields, and pagination cursor before retrying.
    401
    Unauthorized
    The request could not be authenticated because the access token is missing, invalid, or expired. Obtain a new access token and retry the request.
    403
    Forbidden
    The request was valid but lacked the necessary permissions. The access token does not hold a required scope, or you do not administer the target team. Verify your scopes and team administrator role before sending the request again. The response does not reveal whether the resource exists. An ineligible team or selected product returns problem type https://developer.api.autodesk.com/problems/team-not-eligible, title Team not eligible, and detail “This team is not eligible for Public API access.” or “The selected product is not eligible for Public API access.”
    404
    Not Found
    The requested resource could not be found, or is not visible to you. Review the request and try again.
    422
    Unprocessable Entity
    The request is well formed but could not be applied to the team, for example because of a pool with no seats available. Review the request against the team’s policies and available seats before retrying.
    429
    Too Many Requests
    A request rate limit was exceeded. Wait for the number of seconds in the Retry-After header before retrying.
    500
    Internal Server Error
    An unexpected error occurred in the service. Retry the request later. If the problem persists, contact support and include the request ID.
    502
    The API could not complete the request. Retry later. If the problem persists, contact support with the request ID when available.
    503
    Service Unavailable
    The API is temporarily unavailable. Wait for Retry-After when provided before retrying. For a write, check the user or assignment before retrying because the change may have completed. If the problem persists, contact support with the request ID when available.
    504
    The request did not complete in time. For a read, retry later. For a write, check the user or assignment before retrying because the change may have completed.

    Response

    Header (200)

    X-Request-Id
    string
    An identifier used to trace the API request across services and logs. Returns the valid identifier provided in the request header or a newly generated identifier if the request header was missing or invalid. May be omitted from some error responses.
    X-RateLimit-Limit
    integer
    The team’s shared request allowance per UTC minute, when rate-limit processing has completed.
    X-RateLimit-Remaining
    integer
    The number of requests remaining in the team’s shared allowance, when rate-limit processing has completed.
    X-RateLimit-Reset
    integer
    The time, in UTC epoch seconds, at which the team’s allowance resets, when rate-limit processing has completed.

    Response

    Header (201)

    X-Request-Id
    string
    An identifier used to trace the API request across services and logs. Returns the valid identifier provided in the request header or a newly generated identifier if the request header was missing or invalid. May be omitted from some error responses.
    X-RateLimit-Limit
    integer
    The team’s shared request allowance per UTC minute, when rate-limit processing has completed.
    X-RateLimit-Remaining
    integer
    The number of requests remaining in the team’s shared allowance, when rate-limit processing has completed.
    X-RateLimit-Reset
    integer
    The time, in UTC epoch seconds, at which the team’s allowance resets, when rate-limit processing has completed.
    Location
    string
    The URI of the newly added user, relative to the API host and starting with /team-admin/v1. Send a GET request to this URI to retrieve the user.

    Response

    Header (429)

    Retry-After
    integer
    The number of seconds to wait before retrying the request.
    X-Request-Id
    string
    An identifier used to trace the API request across services and logs. Returns the valid identifier provided in the request header or a newly generated identifier if the request header was missing or invalid. May be omitted from some error responses.
    X-RateLimit-Limit
    integer
    The team’s shared request allowance per UTC minute, when rate-limit processing has completed.
    X-RateLimit-Remaining
    integer
    The number of requests remaining in the team’s shared allowance, when rate-limit processing has completed.
    X-RateLimit-Reset
    integer
    The time, in UTC epoch seconds, at which the team’s allowance resets, when rate-limit processing has completed.

    Response

    Header (503)

    Retry-After
    integer
    The minimum number of seconds to wait before retrying, when provided.

    Response

    Body Structure (200)

    id
    string
    Unique identifier for the user. Use this value as the user-id URI parameter in API requests to access this user’s data. Do not parse, derive, or construct it.

    Max length: 256

    firstName
    string
    The given name of the user.
    lastName
    string
    The family name of the user.
    email
    string
    The primary email address of the user.
    role
    enum:string
    The role the user holds on the team. Possible values:
    • PRIMARY_ADMIN - The primary administrator of the team.
    • SECONDARY_ADMIN - A secondary administrator of the team.
    • SSO_ADMIN - An administrator responsible for the team’s single sign-on (SSO) configuration.
    • USER - A standard user of the team.
    • EXTERNAL_USER - A guest user who belongs to the team but is external to it.
    isEmailVerified
    boolean
    An account-registration indicator. Do not use it as proof of email ownership or as the status of team membership.
    • true: No pending invitation or registration is reported. This value does not independently confirm that the email address was verified.
    • false: Account invitation or registration is pending.

    Response

    Body Structure (201)

    id
    string
    Unique identifier for the user. Use this value as the user-id URI parameter in API requests to access this user’s data. Do not parse, derive, or construct it.

    Max length: 256

    firstName
    string
    The given name of the user.
    lastName
    string
    The family name of the user.
    email
    string
    The primary email address of the user.
    role
    enum:string
    The role the user holds on the team. Possible values:
    • PRIMARY_ADMIN - The primary administrator of the team.
    • SECONDARY_ADMIN - A secondary administrator of the team.
    • SSO_ADMIN - An administrator responsible for the team’s single sign-on (SSO) configuration.
    • USER - A standard user of the team.
    • EXTERNAL_USER - A guest user who belongs to the team but is external to it.
    isEmailVerified
    boolean
    An account-registration indicator. Do not use it as proof of email ownership or as the status of team membership.
    • true: No pending invitation or registration is reported. This value does not independently confirm that the email address was verified.
    • false: Account invitation or registration is pending.

    Response

    Body Structure (401 403 404)

    messages
    string
    A message describing the outcome of the request

    Example

    The user was successfully added to the team. The invitation may still be pending acceptance.

    Request

    curl -v 'https://developer.api.autodesk.com/team-admin/v1/teams/100001/users' \
      -X 'POST' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
      -H 'Content-Type: application/json' \
      -d '{
            "email": "ada.lovelace@example.com",
            "firstName": "Ada",
            "lastName": "Lovelace"
          }'
    
    Show More

    Response

    {
      "id": "US1234567890",
      "firstName": "Ada",
      "lastName": "Lovelace",
      "email": "ada.lovelace@example.com",
      "role": "USER",
      "isEmailVerified": true
    }
    
    Show More