Chapter 41. identity

This chapter describes the commands under the identity command.

41.1. identity provider create

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>

Table 41.1. Positional Arguments

ValueSummary

<name>

New identity provider name (must be unique)

Table 41.2. Optional 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

Table 41.3. Output Formatters

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

Table 41.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 41.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 41.6. Table Formatter

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

Delete identity provider(s)

Usage:

openstack identity provider delete [-h]
                                          <identity-provider>
                                          [<identity-provider> ...]

Table 41.7. Positional Arguments

ValueSummary

<identity-provider>

Identity provider(s) to delete

Table 41.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

41.3. identity provider list

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]

Table 41.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 41.10. Output Formatters

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

--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

Table 41.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 41.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 41.13. Table Formatter

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

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>

Table 41.14. Positional Arguments

ValueSummary

<identity-provider>

Identity provider to modify

Table 41.15. Optional 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

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>

Table 41.16. Positional Arguments

ValueSummary

<identity-provider>

Identity provider to display

Table 41.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 41.18. Output Formatters

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

Table 41.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 41.20. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 41.21. Table Formatter

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.