users/me
Retrieves the Autodesk ID, assigned roles, and permitted actions for the current user within a specified project.
This endpoint serves two main purposes:
- To retrieve the Autodesk ID and roles of the current user in Submittals.
- To obtain the list of actions the user is permitted to perform in the system, such as
Item::create
andSpec::create
.
For more information on roles and permissions in Submittals, refer to the Help documentation.
For detailed steps on creating submittal items, refer to the Create Submittal Item tutorial.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/submittals/v2/projects/:projectId/users/me |
Authentication Context | user context required |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
Request
URI Parameters
projectId string: UUID | The ID of the project.
Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You need to convert the project ID into a project ID for the ACC API by removing the “b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7. |
Response
HTTP Status Code Summary
200 OK | Returns user details. |
401 Unauthorized | Invalid Authorization header. Verify and try again. |
403 Forbidden | The user is not authorized to perform this action. |
404 Not Found | The specified resource was not found. |
500 Internal Server Error | An unexpected error occurred on the server while processing the request. |
Response
Body Structure (200)
id string | The AutodeskId for the current user. |
roles array: string | The roles assigned to the user in Submittals. Possible values: 1 - Manager , 2 - User , 4 - Admin |
permittedActions array: object | A list of actions that the user is allowed to perform |
id string | ID of the action in the format type_of_object::action . For example, item::create , Spec::create . |
fields object | A mapping of field names to lists of possible values for each field, specific to the associated action. An empty array indicates that there is no specific set of values for those fields.
For example, in the action |
mandatoryFields array: string | A subset of fields (fields ) that are required to perform specific actions, such as creating or transitioning a submittal item. The required fields depend on the user’s role and the action.
For example, creating a submittal item in the |
transitions array: object | Possible state transitions for a submittal object.
A submittal item can be in one of the following states:
|
id string | The ID of the transition in the format from-state::to-state . Possible values: create::mgr-1 , create::sbc-1 . |
name string | The descriptive name of the transition. Possible values: Create , Send to Manager , Send to void . |
stateFrom object | The starting state of the transition. |
id string | The unique ID of the starting state. Possible values: create , mgr-1 , sbc-1 . A rev (review), refers to the state where a submittal item is undergoing revisions or is being reviewed. |
name string | The name of the starting state. Possible values: Create , Manager Review , Review . |
stateTo object | The target state of the transition. |
id string | The unique ID of the target state. For example, mgr-1 , mgr-2 , void . |
name string | The name of the target state. For example, Manager Review , Manager Final Review , Void . |
transitionFields array: string | Fields that are used in the transition. For example, [subcontractor , subcontractorType , watchers , responseId ]. |
mandatoryFields array: string | A list of required fields for the transition. For example, [responseId ]. |
actionId string | Not relevant |
Example
Returns user details.
Request
curl -v 'https://developer.api.autodesk.com/construction/submittals/v2/projects/9eae7d59-1469-4389-bfb2-4114e2ba5545/users/me' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"id": "GJDGNLSX7B8T",
"roles": [
"1",
"2",
"4"
],
"permittedActions": [
{
"id": "Item::create",
"fields": {},
"mandatoryFields": [
""
],
"transitions": [
{
"id": "create::mgr-1",
"name": "Create",
"stateFrom": {
"id": "create",
"name": "Create"
},
"stateTo": {
"id": "mgr-1",
"name": "MGR 1"
},
"transitionFields": [
"manager",
"managerType",
"stateId",
"title",
"description",
"priority"
],
"mandatoryFields": [
[
"manager",
"managerType",
"stateId",
"title"
]
],
"actionId": "ITEM_TRANSITION_CREATE_MGR1"
}
]
}
]
}