teams/{team-id}/assignments
Assigns a seat from a team product pool to a user. Only DIRECT assignments can be created. The product ID must come from the List Product Pools operation. Known unsupported product pools are rejected as unprocessable. This operation does not currently enforce a reassignment quota.
The operation converges: creating an assignment that already exists leaves the team in the same state. Whether the assignment is new or already existed, the response contains the current assignment.
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}/assignments |
| Authentication Context | User-delegated only (accepts only three-legged access tokens) |
| Required OAuth Scopes | tmadmapi:team-products: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 |
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
| userId* 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 |
| productId* string | An opaque product identifier returned by the List Product Pools operation. The same value identifies the product in pools and assignments. Use it as productId when creating, removing, or filtering assignments. Store and reuse it without parsing, deriving, or constructing it.
Max length: 128 |
| assignmentType enum:string | Optional. Omit it or set it to DIRECT. Will always be: DIRECT |
Response
HTTP Status Code Summary
| 200 OK | The assignment already existed. The current assignment was successfully retrieved without changes. |
| 201 Created | The new assignment was successfully created. |
| 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 root-relative path of the new assignment, including the public API base path. The assignment is identified by its userId and productId. |
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)
| userId 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 |
| email string | The email address of the assigned user. |
| teamId string | Unique identifier for the team. Use this value as the team-id URI parameter in API requests to access this team’s data. Store and reuse the value without parsing, deriving, or constructing it.
Max length: 256 |
| productId string | An opaque product identifier returned by the List Product Pools operation. The same value identifies the product in pools and assignments. Use it as productId when creating, removing, or filtering assignments. Store and reuse it without parsing, deriving, or constructing it.
Max length: 128 |
| productName string | The marketing name of the product. null when the name cannot be resolved. |
| assignmentType enum:string | The way the user holds the product assignment. When a user holds the same product in more than one way, the value reflects the first match in the order listed below. Possible values:
|
Response
Body Structure (201)
| userId 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 |
| email string | The email address of the assigned user. |
| teamId string | Unique identifier for the team. Use this value as the team-id URI parameter in API requests to access this team’s data. Store and reuse the value without parsing, deriving, or constructing it.
Max length: 256 |
| productId string | An opaque product identifier returned by the List Product Pools operation. The same value identifies the product in pools and assignments. Use it as productId when creating, removing, or filtering assignments. Store and reuse it without parsing, deriving, or constructing it.
Max length: 128 |
| productName string | The marketing name of the product. null when the name cannot be resolved. |
| assignmentType enum:string | The way the user holds the product assignment. When a user holds the same product in more than one way, the value reflects the first match in the order listed below. Possible values:
|
Response
Body Structure (401 403 404)
| messages string | A message describing the outcome of the request |
Example
The new assignment was successfully created.
Request
curl -v 'https://developer.api.autodesk.com/team-admin/v1/teams/100001/assignments' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"userId": "US1234567890",
"productId": "prod_8f3a1c9d7b2e",
"assignmentType": "DIRECT"
}'
Response
{
"userId": "US1234567890",
"email": "ada.lovelace@example.com",
"teamId": "100001",
"productId": "prod_8f3a1c9d7b2e",
"productName": "Example Product Premium",
"assignmentType": "DIRECT"
}