Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 41. identity

This chapter describes the commands under the identity command.

41.1. identity provider create
Copy link

Create new identity provider

Usage:

openstack identity provider create [-h]
                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN] [--noindent]
                                          [--prefix PREFIX]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--remote-id <remote-id> | --remote-id-file <file-name>]
                                          [--description <description>]
                                          [--domain <domain>]
                                          [--enable | --disable]
                                          <name>
Copy to Clipboard Toggle word wrap

Expand
Table 41.1. Positional arguments
ValueSummary

<name>

New identity provider name (must be unique)

Expand
Table 41.2. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--remote-id <remote-id>

Remote ids to associate with the identity provider (repeat option to provide multiple values)

--remote-id-file <file-name>

Name of a file that contains many remote ids to associate with the identity provider, one per line

--description <description>

New identity provider description

--domain <domain>

Domain to associate with the identity provider. if not specified, a domain will be created automatically. (Name or ID)

--enable

Enable identity provider (default)

--disable

Disable the identity provider

Expand
Table 41.3. Output formatter options
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Expand
Table 41.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 41.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 41.6. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

41.2. identity provider delete
Copy link

Delete identity provider(s)

Usage:

openstack identity provider delete [-h]
                                          <identity-provider>
                                          [<identity-provider> ...]
Copy to Clipboard Toggle word wrap

Expand
Table 41.7. Positional arguments
ValueSummary

<identity-provider>

Identity provider(s) to delete

Expand
Table 41.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

41.3. identity provider list
Copy link

List identity providers

Usage:

openstack identity provider list [-h] [-f {csv,json,table,value,yaml}]
                                        [-c COLUMN]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--noindent] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--sort-column SORT_COLUMN]
                                        [--sort-ascending | --sort-descending]
                                        [--id <id>] [--enabled]
Copy to Clipboard Toggle word wrap

Expand
Table 41.9. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--id <id>

The identity providers’ id attribute

--enabled

The identity providers that are enabled will be returned

Expand
Table 41.10. Output formatter options
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 41.11. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Expand
Table 41.12. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 41.13. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

41.4. identity provider set
Copy link

Set identity provider properties

Usage:

openstack identity provider set [-h] [--description <description>]
                                       [--remote-id <remote-id> | --remote-id-file <file-name>]
                                       [--enable | --disable]
                                       <identity-provider>
Copy to Clipboard Toggle word wrap

Expand
Table 41.14. Positional arguments
ValueSummary

<identity-provider>

Identity provider to modify

Expand
Table 41.15. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Set identity provider description

--remote-id <remote-id>

Remote ids to associate with the identity provider (repeat option to provide multiple values)

--remote-id-file <file-name>

Name of a file that contains many remote ids to associate with the identity provider, one per line

--enable

Enable the identity provider

--disable

Disable the identity provider

41.5. identity provider show
Copy link

Display identity provider details

Usage:

openstack identity provider show [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--noindent]
                                        [--prefix PREFIX]
                                        [--max-width <integer>] [--fit-width]
                                        [--print-empty]
                                        <identity-provider>
Copy to Clipboard Toggle word wrap

Expand
Table 41.16. Positional arguments
ValueSummary

<identity-provider>

Identity provider to display

Expand
Table 41.17. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 41.18. Output formatter options
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated to show multiple columns

Expand
Table 41.19. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 41.20. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 41.21. Table formatter options
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat