---
schema_version: "1"
id: f5e22284f12b46a942cb595c6a79039d7d0d00fe853677465a4206ecf3fff8f5
title: tsm user-identity-store
collection: tableau
version: next
locale: en-us
portal_url: https://docs.salesforce.com/tableau/next/en-us/server/cli_user-identity_tsm.md
canonical_url: https://help.tableau.com/v0.0/server/en-us/cli_user-identity_tsm.htm
source_site: help.tableau.com
content_type: documentation
content_hash: a0b405b12544b559c5dc09032c474132cff775a1387205aaa55387fd7c05ce7a
description: Reference for tsm user-identity-store commands to modify identity store settings after install.
---
[Skip to main content](#main-content)

# tsm user-identity-store

You can use the `tsm user-identity-store` commands to modify the settings of the identity store for Tableau Server after the initial configuration.

The initial configuration of the identity store is part of the installation process. See [Configure Initial Node Settings](https://help.tableau.com/v0.0/server/en-us/config_general.htm).

For introduction to identity store concepts, see [Identity Store](https://help.tableau.com/v0.0/server/en-us/plan_identity_store.htm).

For LDAP/Active Directory configuration reference table, see [External Identity Store Configuration Reference](https://help.tableau.com/v0.0/server/en-us/ldap_config.htm).

- [get-group-mappings](#TSMGroupMap)
- [get-user-mappings](#TSMUserMap)
- [list](#TSMUIList)
- [set-connection](#TSMSetConnection)
- [set-group-mappings](#TSMSetGroupMap)
- [set-user-mappings](#TSMSetUserMap)
- [verify-group-mappings](#TSMverify-group-mappings)
- [verify-user-mappings](#TSMIDverify-user-mappings__[options])

## tsm user-identity-store get-group-mappings \[options\]

Displays identity store group mappings.

### Synopsis

tsm user-identity-store get-group-mappings \[global options\]

## tsm user-identity-store get-user-mappings \[options\]

Displays identity store user mappings.

### Synopsis

tsm user-identity-store get-user-mappings \[global options\]

## tsm user-identity-store list \[options\]

Lists user-identity configuration.

### Synopsis

tsm user-identity-store list \[options\] \[global options\]

### Options

\-v, --verbose

Optional.

Lists all configuration parameters.

## tsm user-identity-store set-connection \[options\]

Sets identity store connection parameters.

### Synopsis

tsm user-identity-store set-connection --kerbkeytab <kerbkeytab> \[options\] \[global options\]

### Options

\-b,--bind <username and password | Kerberos>

Optional.

Set LDAP bind type.

\-d,--domain <domain>

Optional.

Domain name.

\-hn,--hostname <hostname>

Optional.

The hostname of the LDAP server. You can enter a hostname or an IP address for this value. The host that you specify here will be used for user/group queries on the primary domain. In the case where user/group queries are in other domains, Tableau Server will query DNS to identify the appropriate domain controller.

\-kc,--kerbconfig <kerbconfig>

Optional.

Kerberos configuration file path.

\-kp,--kerbprincipal <kerbprincipal>

Optional.

Kerberos Principal.

\-kt,--kerbkeytab <kerbkeytab>

Required.

Kerberos keytab file path.

\-l,--port <port>

Optional.

Set LDAP Port value.

\-lp,--ldappassword <ldappassword>

Optional.

LDAP Password.

\-lu,--ldapusername <ldapusername>

Optional.

Set LDAP Username value.

\-n,--nickname <nickname>

Optional.

NetBIOS name (nickname).

## tsm user-identity-store set-group-mappings \[options\]

Sets identity store group mappings and configures LDAP directories that implement an arbitrary or custom schema.

### Synopsis

tsm user-identity-store set-group-mappings \[options\] \[global options\]

### Options

\-b,--basefilter <groupbasefilter>

Optional.

Set group BaseFilter value.

\-cn,--classnames <group\_classnames>

Optional.

Override default user classname values (contains "group" string) with the values you set here. You can provide multiple classnames separated by commas.

\-d,--description <description>

Optional.

Group description.

\-e,--groupemail <groupemail>

Optional.

Group email value.

\-m,--member <member>

Optional.

Set the group members.

\-n,--groupname <groupname>

Optional.

Name of the group.

## tsm user-identity-store set-user-mappings \[options\]

Sets identity store user mappings and configures LDAP directories that implement an arbitrary or custom schema.

### Synopsis

tsm user-identity-store set-user-mappings --certificate <certificate> \[options\] \[global options\]

### Options

\-c,--certificate <certificate>

Optional.

Users' certificate file location.

\-cn,--classnames <user\_classnames>

Optional.

Override default user classname values ("user" and "inetOrgPerson") with the values you set here. You can provide multiple classnames separated by commas.

\-dn,--displayname <displayname>

Optional.

Display name of the user.

\-e,--email <email>

Optional.

Users' email address.

\-jp,--jpegphoto <jpegfile>

Optional.

Users' jpeg image location.

\-m,--memberof <groupname>

Optional.

Group that the user is a member of.

\-t,--thumbnail <thumbnail>

Optional.

Users' thumbnail location.

\-ub,--basefilter <userbasefilter>

Optional.

Users' BaseFilter.

\-uu,--ldapusername <ldapusername>

Optional.

User name.

## tsm user-identity-store verify-group-mappings \[options\]

Validates configuration for LDAP group mapping.

**Note:** This command uses the credentials stored in `[wgserver.domain.username](https://help.tableau.com/v0.0/server/en-us/cli_configuration-set_tsm.htm#wgserver-domain-username)` and `[wgserver.domain.password](https://help.tableau.com/v0.0/server/en-us/cli_configuration-set_tsm.htm#wgserver-domain-password)` . If these keys are not configured, the command will fail even if Tableau Server is otherwise successfully connected to Active Directory.

### Synopsis

tsm user-identity-store verify-group-mappings --verify <group\_name> \[global options\]

### Options

\-v,--verify <group\_name>

Optional.

Name of group to search for.

## tsm user-identity-store verify-user-mappings \[options\]

Validates configuration for LDAP user mapping.

**Note:** This command uses the credentials stored in `[wgserver.domain.username](https://help.tableau.com/v0.0/server/en-us/cli_configuration-set_tsm.htm#wgserver-domain-username)` and `[wgserver.domain.password](https://help.tableau.com/v0.0/server/en-us/cli_configuration-set_tsm.htm#wgserver-domain-password)` . If these keys are not configured, the command will fail even if Tableau Server is otherwise successfully connected to Active Directory.

### Synopsis

tsm user-identity-store verify-user-mappings --verify <user\_name> \[global options\]

### Options

\-v,--verify <user\_name>

Optional.

Name of user to search for.

## Global options

\-h, --help

Optional.

Show the command help.

\-p, --password <password>

Required, along with `-u` or `--username` if no session is active.

Specify the password for the user specified in `-u` or `--username`.

If the password includes spaces or special characters, enclose it in quotes:

`--password "my password"`

\-s, --server https://<hostname>:8850

Optional.

Use the specified address for Tableau Services Manager. The URL must start with `https`, include port 8850, and use the server name not the IP address. For example `https://<tsm_hostname>:8850`. If no server is specified, `https://<localhost | dnsname>:8850` is assumed.

\--trust-admin-controller-cert

Optional.

Use this flag to trust the self-signed certificate on the TSM controller. For more information about certificate trust and CLI connections, see [Connecting TSM clients](https://help.tableau.com/v0.0/server/en-us/tsm_overview.htm#Connecti).

\-u, --username <user>

Required if no session is active, along with `-p` or `--password`.

Specify a user account. If you do not include this option, the command is run using credentials you signed in with.