Autodesk Users API

The Users API from Autodesk — 1 operation(s) for users.

GitHub OpenAPI

Operations 2

GET /userinfo Get User Info #
GET /userprofile/v1/users/@me Autodesk Get User Profile #

Documentation

📖
Documentation
https://aps.autodesk.com/developer/overview/authentication-api
📖
APIReference
https://aps.autodesk.com/en/docs/oauth/v2/reference/http
📖
GettingStarted
https://aps.autodesk.com/en/docs/oauth/v2/tutorials
📖
Documentation
https://aps.autodesk.com/developer/overview/data-management-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/data/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/model-derivative-api
📖
APIReference
https://aps.autodesk.com/en/docs/model-derivative/v2/reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/model-derivative/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/automation-api
📖
Documentation
https://aps.autodesk.com/webhooks-api
📖
APIReference
https://aps.autodesk.com/en/docs/webhooks/v1/reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/webhooks/v1/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/reality-capture-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/reality-capture/v1/tutorials/create-3d-mesh-from-photos/
📖
Documentation
https://aps.autodesk.com/developer/overview/sustainability-data-api
📖
APIReference
https://aps.autodesk.com/en/docs/sustainability/v3/reference/http/
📖
GettingStarted
https://aps.autodesk.com/en/docs/sustainability/v3/tutorials/tutorial_01/
📖
Documentation
https://aps.autodesk.com/developer/overview/parameters-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/parameters/v1/tutorials/getting-started/
📖
Documentation
https://aps.autodesk.com/developer/overview/tandem-data-api
📖
Documentation
https://aps.autodesk.com/developer/overview/flow-graph-engine-api
📖
APIReference
https://aps.autodesk.com/en/docs/flow_graph_engine/v1/reference/quick_reference/
📖
Documentation
https://aps.autodesk.com/developer/overview/autodesk-construction-cloud
📖
GettingStarted
https://aps.autodesk.com/en/docs/acc/v1/tutorials/admin
📖
APIReference
https://aps.autodesk.com/en/docs/acc/v1/reference
📖
Documentation
https://aps.autodesk.com/developer/overview/bim-360-api
📖
APIReference
https://aps.autodesk.com/en/docs/bim360/v1/reference/

Specifications

Schemas & Data

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/autodesk:autodesk-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

autodesk-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Autodesk Users API
  x-refined-note:
  - x-support differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Users across 2 of this provider''s published API definitions: aps-sdk-openapi-authentication-authentication.yaml, autodesk-authentication-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://developer.api.autodesk.com
tags:
- name: Users
paths:
  /userinfo:
    servers:
    - url: https://api.aps.autodesk.com
      description: The User Profile API host. This operation is served by the User Profile API, not the Authentication API, so it does not share the Authentication host.
    - url: https://developer.api.autodesk.com
      description: Legacy host, still supported for this operation.
    get:
      summary: Get User Info
      tags:
      - Users
      responses:
        '200':
          description: Information about the currently logged in user was successfully returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
              examples:
                example-1:
                  summary: This example demonstrates successful retrieval of a user profile.
                  value:
                    sub: ABCDEFGH
                    name: First Last
                    given_name: First
                    family_name: Last
                    preferred_username: username
                    email: test@test.com
                    email_verified: true
                    profile: https://profile(-dev/-int/-stg/'').autodesk.com
                    picture: https://images.profile(-dev/-int/-stg/'').autodesk.com/ABCDEFGH/profilepictures/x120.jpg
                    locale: en-US
                    updated_at: 1662583480
                    is_twofa_enabled: false
                    country_code: US
                    address:
                      street_address: 'testaddress1

                        '
                      locality: testcity
                      region: ''
                      postal_code: ''
                      country: US
                    phone_number: '+1 1234567890 #123'
                    phone_number_verified: false
                    ldap_enabled: true
                    ldap_domain: autodesk.com
                    job_title: 3D generalist
                    industry: IT/Software development
                    industry_code: NoGroupOther
                    about_me: I'm completing a test right now.
                    language: en
                    company: Autodeskf
                    created_date: '2017-12-11T20:54:18Z'
                    last_login_date: '2020-05-10T04:00:29Z'
                    eidm_guid: ABCDEFGH
                    opt_in: false
                    social_userinfo_list:
                    - socialUserId: test.social_userid
                      providerId: test1.uid
                      providerName: Google
                    twofa_type: Phone
                    contact_mode: SMS
                    user_source_type: Provisioned
                    user_thumbnails:
                      sizeX20: https://images.profile-dev.autodesk.com/default/user_X20.png
                      sizeX40: https://images.profile-dev.autodesk.com/default/user_X40.png
                      sizeX50: https://images.profile-dev.autodesk.com/default/user_X50.png
                      sizeX58: https://images.profile-dev.autodesk.com/default/user_X58.png
                      sizeX80: https://images.profile-dev.autodesk.com/default/user_X80.png
                      sizeX120: https://images.profile-dev.autodesk.com/default/user_X120.png
                      sizeX160: https://images.profile-dev.autodesk.com/default/user_X160.png
                      sizeX176: https://images.profile-dev.autodesk.com/default/user_X176.png
                      sizeX240: https://images.profile-dev.autodesk.com/default/user_X240.png
                      sizeX360: https://images.profile-dev.autodesk.com/default/user_X360.png
        '400':
          description: The server was unable to process the request. The syntax of the request may be malformed or may be missing a required parameter. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request.
        '401':
          description: The access token is invalid. It may have either expired or may not be a three-legged access token. Please verify the token and retry the request.
        '403':
          description: The request was successfully validated but lacked required permission. Please verify your credentials and permissions and retry the request.
        '429':
          description: Rate limit exceeded; wait some time before retrying.
        '500':
          description: An unknown server-side error occurred. Please try again later. If the problem persists, please contact support.
      operationId: get-user-info
      description: 'Retrieves the profile information of an authorizing end user in a OIDC-compliant three-legged context.


        This operation has a rate limit of 500 calls per minute.


        **Note:** This operation is documented under the `User Profile API `_, not the Authentication API, and its canonical host is ``https://api.aps.autodesk.com``. It is kept here because OIDC discovery advertises ``userinfo_endpoint`` alongside the other Authentication endpoints, and because ``https://developer.api.autodesk.com`` remains supported for it.


        **Note:** This operation requires the ``openid`` scope. Additional scopes control which fields are returned; most requests need ``openid profapi:core-std-profile:read``.'
      security:
      - 3-legged: []
      parameters: []
  /userprofile/v1/users/@me:
    get:
      operationId: getUserProfile
      summary: Autodesk Get User Profile
      description: Returns the profile information of the authenticated user.
      tags:
      - Users
      security:
      - OAuth2ThreeLegged:
        - user-profile:read
      responses:
        '200':
          description: Successfully retrieved user profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfile'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://developer.api.autodesk.com
      description: Production
components:
  schemas:
    UserInfo:
      type: object
      x-stoplight:
        id: 76f4f5a6324c0
      properties:
        sub:
          type: string
          description: The ID by which APS uniquely identifies the user.
        name:
          type: string
          description: The full name of the user.
        given_name:
          type: string
          description: The given name or first name of the user.
        family_name:
          type: string
          description: The surname or last name of the user.
        preferred_username:
          type: string
          description: The username by which the user prefers to be addressed.
        email:
          type: string
          description: The email address by which the user prefers to be contacted.
        email_verified:
          type: boolean
          description: '``true`` : The user''s preferred email address is verified.


            ``false``: The user''s preferred email address is not verified.

            '
        profile:
          type: string
          description: The URL of the profile page of the user.
        picture:
          type: string
          description: The URL of the profile picture of the user.
        locale:
          type: string
          description: The preferred language settings of the user. This setting is typically specified as a combination of the ISO 639 language code in lower case, and the ISO 3166 country code in upper case, separated by a dash character. For example ``en-US``.
        updated_at:
          type: integer
          description: The time the user's information was most recently updated, represented as a Unix timestamp.
        is_twofa_enabled:
          type: boolean
          description: '``true``: Two-factor authentication is enabled for this user.


            ``false``: Two-factor authentication is not enabled for this user.

            '
        country_code:
          type: string
          description: The ISO 3166 country code that was assigned to the user when their profile was created.
        address:
          type: object
          description: A JSON object containing information of the postal address of the user.
          properties:
            street_address:
              type: string
              description: The street address part of the address. Can contain the house number, street name, postal code, and so on.  New lines are represented as ``\n``.
            locality:
              type: string
              description: The city or locality part of the address.
            region:
              type: string
              description: The state, province, prefecture, or region part of the address.
            postal_code:
              type: string
              description: The zip code or postal code part of the address.
            country:
              type: string
              description: The country name part of the address.
        phone_number:
          type: string
          description: The phone number by which the user prefers to be contacted.
        phone_number_verified:
          type: boolean
          description: '``true`` : The phone number is verified.


            ``false`` : The phone number is not verified.

            '
        ldap_enabled:
          type: boolean
          description: '``true`` :  Single sign-on using Lightweight Directory Access Protocol (LDAP) is enabled for this user.


            ``false`` : LDAP is not enabled for this user.

            '
        ldap_domain:
          type: string
          description: The domain name used by the LDAP server for user authentication. ``null``, if ``ldap_enabled`` is ``false``.
        job_title:
          type: string
          description: The job title of the user as specified in the user's profile.
        industry:
          type: string
          description: The industry the user works in, as specified in the user's profile.
        industry_code:
          type: string
          description: A code that corresponds to the industry.
        about_me:
          type: string
          description: A short description written by the user to introduce themselves, as specified in the user's profile.
        language:
          type: string
          description: The ISO 639 language code of the preferred language of the user.
        company:
          type: string
          description: The company that the user works for, as specified in the user's profile.
        created_date:
          type: string
          description: The time the user profile was created, represented as a Unix timestamp.
        last_login_date:
          type: string
          description: The time the user most recently signed-in to APS successfully, represented as a Unix timestamp.
        eidm_guid:
          type: string
          description: An ID to uniquely identify the user. For most users this will be the same as ``sub``. However, for users profiles created on the now retired EIDM system ``eidm_guid`` will be different from ``sub``.
        opt_in:
          type: boolean
          description: '``true`` : The user has agreed to receive marketing information.


            ``false``: The user does not want to receive marketing information.

            '
        social_userinfo_list:
          type: array
          description: An array of objects, where each object represents a social media account that can be used to verify the user's identity.
          items:
            type: object
            properties:
              socialUserId:
                type: string
                description: The ID of the user within the social media platform.
              providerId:
                type: string
                description: The ID of the social media platform.
              providerName:
                type: string
                description: The name of the social media platform.
        twofa_type:
          type: string
          description: 'The type of two-factor authentication enabled for the user. Possible values: Phone, Email, Authenticator.'
        contact_mode:
          type: string
          description: 'The mode of contact for two-factor authentication. Possible values: SMS, Email, Authenticator.'
        user_source_type:
          type: string
          description: 'The source type of the user where the value indicates how the user was created. Possible values: Identity, EIDM, Rest API, Ldap/Enterprise, Test User, Provisioned, Ldap Provisioned.'
        user_thumbnails:
          type: object
          additionalProperties:
            type: string
          description: An array of key-value pairs for image URLs of available thumbnail sizes of the user's profile picture. The key is named ``sizeX<NUMBER>`` where ``<NUMBER>`` is the width and height of the thumbnail, in pixels. The corresponding value is the unique, secure, pre-signed & short-lived URL pointing to the thumbnail. For example, ``sizeX120`` would contain the URL for the 120x120 pixel thumbnail.
      title: UserInfo Response
      description: Represents a successful response to a Get User Info operation.
    UserProfile:
      type: object
      properties:
        userId:
          type: string
          description: The unique identifier of the user.
        userName:
          type: string
          description: The username.
        emailId:
          type: string
          description: The user's email address.
        firstName:
          type: string
          description: The user's first name.
        lastName:
          type: string
          description: The user's last name.
        emailVerified:
          type: boolean
          description: Whether the email has been verified.
        2FaEnabled:
          type: boolean
          description: Whether two-factor authentication is enabled.
        profileImages:
          type: object
          description: URLs of the user's profile images.
          properties:
            sizeX20:
              type: string
            sizeX40:
              type: string
            sizeX50:
              type: string
            sizeX58:
              type: string
            sizeX80:
              type: string
            sizeX120:
              type: string
            sizeX160:
              type: string
            sizeX176:
              type: string
            sizeX240:
              type: string
            sizeX360:
              type: string
    ErrorResponse:
      type: object
      properties:
        developerMessage:
          type: string
          description: A developer-facing error message.
        userMessage:
          type: string
          description: A user-facing error message.
        errorCode:
          type: string
          description: An error code.
        more info:
          type: string
          description: A link to more information about the error.
  securitySchemes:
    client-credentials:
      type: http
      description: Basic Authorization by providing client id and client secret.
      scheme: basic
    basic-auth:
      type: http
      description: 'Authorization:  Basic clientIdclientsecret'
      scheme: basic
    3-legged:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://developer.api.autodesk.com/authentication/v2/authorize
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          refreshUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: read your data
            data:write: modify your data
            data:create: create new data
      x-authentication_context: user context required
      description: User context required.
    2-legged:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: read application accessible data
            data:write: write application accessible data
            data:create: create application accessible data
      x-authentication_context: application context required
      description: Application context required.
    OAuth2TwoLegged:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: Read access to data
            data:write: Write access to data
            data:create: Create new data
            data:search: Search data
            bucket:create: Create OSS buckets
            bucket:read: Read OSS buckets
            bucket:update: Update OSS buckets
            bucket:delete: Delete OSS buckets
            code:all: Execute Design Automation activities
            account:read: Read account data
            account:write: Write account data
    OAuth2ThreeLegged:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://developer.api.autodesk.com/authentication/v2/authorize
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: Read access to data
            data:write: Write access to data
            data:create: Create new data
            data:search: Search data
            user-profile:read: Read user profile
            account:read: Read account data
            account:write: Write account data
x-refined-from:
- aps-sdk-openapi-authentication-authentication.yaml
- autodesk-authentication-openapi.yml
x-stoplight:
  id: a5p3h5029y9kz