> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mindset.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK Users API

> Parameters full description

<Card title="Note" icon="link" iconType="solid" href="/deploy/api/sdk-users/generate-an-auth-token-for-a-given-user-identifier" cta="SDK Users API playground">
  You can find below the full description of Parameters for the POST method and also what parameters you can expect from the API responses.

  <br />

  If you want to test the API, please see the SDK Users API playground.
</Card>

<AccordionGroup>
  <Accordion title="POST - Generate an auth token">
    ## Parameters:

    #### **name \[String]**

    Friendly name to be set for the user. Optional, this is only used when a new user is created. If the user already exists, this parameter is ignored.

    #### **externalId \[String]**

    Unique user identifier. Valid characters are A-Za-z0-9\_-. Minimum is one (but not both) of externalId or a userEmail

    #### **userEmail \[String]**

    email address format user identifier. Deprecated. Prefer using externalId. Minimum is one (but not both) of externalId or a userEmail

    #### **accountUids \[String\[]]**

    Array of account uids (max 10). The user will be added to these accounts to allow access to restricted agents.

    Please see [Best practice: Agent access granted by Account membership](/sdk-api/sdk/sdk2-best-practices#6-agent-access-granted-by-account-membership)
  </Accordion>

  <Accordion title="RESPONSE DATA">
    #### **authToken** *String*

    authentication token for the user, which can be used to authenticate the user in the Mindset SDK
  </Accordion>
</AccordionGroup>