• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Security & governanceManagementManage users

    Manage users

    Access the user administration page by going to Account > Settings in the navigation sidebar. Then, select Users in the Platform Settings section of the sidebar.

    Manage users

    From here, you can view different information about users within Foundry:

    • User ID: The permanent unique ID of the user.
    • Organization: The Organization to which a user belongs.
    • Groups: The list of groups to which a user belongs.
    • Attributes: Information about a user represented in a key-value format that is typically used by other Foundry services. For example, a user might have an attribute for geographical region which can be used to restrict what objects in the ontology the user can see.

    Learn more about restricted views.

    Preregister user

    Platform administrators with preregister permissions can perform actions on users before they ever log into Foundry. Administrators can create usernames, give users appropriate group memberships, assign Organization and Marking access, and more to ensure the new user has proper access to resources when they first log in.

    The created username needs to match the user’s login username exactly for the preregistered actions to work.

    User inactivity

    Foundry user accounts are automatically considered inactive if no successful login has occurred for 30 days. Inactive accounts behave in the same way as active accounts in Foundry, except that all tokens for the inactive user account are invalid while the account is inactive.

    The inactive user account will be automatically set to active after a successful login, which re-enables all disabled tokens. No administrator action is required for this reactivation.

    It is possible to exclude users in certain Foundry groups and authentication realms from this inactivity behavior. Contact your Palantir representative for more information about these exclusions.

    If a user encounters the message: "Your account has been locked. Contact your support person to unlock it, then try again." upon login, contact your Palantir representative for account unlocking.

    Troubleshooting

    “Your account has been disabled” error

    If a login fails with the error Your account has been disabled, it means the user account has been deleted. You can reach out to an administrator to find and "undelete" the account using the getDeletedUsers and undeleteExternalUser endpoints, respectively. Organization administrators with Manage membership permissions are able to call these endpoints. Example curl requests are listed below.

    Find the deleted user via getDeletedUsers

    This step is optional and only required if the user ID of the deleted user is unknown.

    curl -XGET -H "Authorization: Bearer $TOKEN" '<FOUNDRY_URL>/multipass/api/administration/users/deleted?pageSize=<NUMBER_OF_RESULTS_TO_RETURN>&pageToken=<PAGE_START_TOKEN>'

    Note: The max page size is 1000.

    Undelete the deleted user via undeleteExternalUser

    curl -XPOST -H "Authorization: Bearer $TOKEN" '<FOUNDRY_URL>/multipass/api/administration/users/<USER_ID>/undelete/external'

    User Authentication Tokens

    Foundry platform settings allows users to generate a number of different types of Authentication Tokens. The choice of token depends on the client that is going to use the token and the behavior you are looking to implement.

    Client types

    First-party clients

    First-party clients are internal Foundry services, like Slate, or Build2. First-party clients are written by Palantir, and the Foundry platform settings does not delegate trust to these clients.

    Third-party clients

    Third-party clients are external to Foundry and often written by external parties. Third-party clients are not trusted by Foundry.

    Token types

    Session tokens

    Session tokens are created when a user successfully authenticates with Foundry.

    Session tokens are used when users directly interact with Foundry through the workspace. This includes Foundry platform settings as well as first-party clients like Workspace and Slate.

    API tokens

    All other tokens are API tokens.

    Foundry platform settings support a number of different token grant types, which are different methods by which API tokens can be obtained. Some are standard OAuth2 grant types and others are custom Foundry grant types.

    The Foundry platform settings backend service is called Multipass. For this reason, some of the token names include Multipass in their names.

    Tokens used by third-party clients applications

    authorization_code: This is a standard OAuth2 grant type used by third-party clients ↗ to obtain tokens on behalf of a users.

    multipass_user_generated_token: This is a custom Foundry grant type used for long-lived API tokens that users create for themselves in the Foundry platform settings token interface.

    Tokens used by first-party clients clients

    client_credentials: This is a standard OAuth2 grant type used by first-party clients ↗ (e.g. service users) to obtain tokens for themselves.

    multipass_proxy_token: This is a custom Foundry grant type used by privileged clients to obtain tokens on behalf of a user without requiring that user’s consent.

    multipass_restricted_token: This is a custom Foundry grant type used by privileged clients to obtain tokens that duplicate an existing token but with additional restrictions.