openstackclient.identity.v3 package

Submodules

openstackclient.identity.v3.catalog module

Identity v3 Service Catalog action implementations

class openstackclient.identity.v3.catalog.ListCatalog(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List services in the service catalog

log = <logging.Logger object at 0x4e8f510>
take_action(parsed_args)
class openstackclient.identity.v3.catalog.ShowCatalog(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display service catalog details

get_parser(prog_name)
log = <logging.Logger object at 0x4e8ff10>
take_action(parsed_args)

openstackclient.identity.v3.consumer module

Identity v3 Consumer action implementations

class openstackclient.identity.v3.consumer.CreateConsumer(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new consumer

get_parser(prog_name)
log = <logging.Logger object at 0x60ed690>
take_action(parsed_args)
class openstackclient.identity.v3.consumer.DeleteConsumer(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete consumer

get_parser(prog_name)
log = <logging.Logger object at 0x60ed190>
take_action(parsed_args)
class openstackclient.identity.v3.consumer.ListConsumer(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List consumers

log = <logging.Logger object at 0x60edc90>
take_action(parsed_args)
class openstackclient.identity.v3.consumer.SetConsumer(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set consumer properties

get_parser(prog_name)
log = <logging.Logger object at 0x60ed710>
take_action(parsed_args)
class openstackclient.identity.v3.consumer.ShowConsumer(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display consumer details

get_parser(prog_name)
log = <logging.Logger object at 0x60edb50>
take_action(parsed_args)

openstackclient.identity.v3.credential module

Identity v3 Credential action implementations

class openstackclient.identity.v3.credential.CreateCredential(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create credential command

get_parser(prog_name)
log = <logging.Logger object at 0x4a88c50>
take_action(parsed_args)
class openstackclient.identity.v3.credential.DeleteCredential(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete credential command

get_parser(prog_name)
log = <logging.Logger object at 0x4a88cd0>
take_action(parsed_args)
class openstackclient.identity.v3.credential.ListCredential(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List credential command

log = <logging.Logger object at 0x4a88150>
take_action(parsed_args)
class openstackclient.identity.v3.credential.SetCredential(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set credential command

get_parser(prog_name)
log = <logging.Logger object at 0x4a88810>
take_action(parsed_args)
class openstackclient.identity.v3.credential.ShowCredential(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Show credential command

get_parser(prog_name)
log = <logging.Logger object at 0x4a88390>
take_action(parsed_args)

openstackclient.identity.v3.domain module

Identity v3 Domain action implementations

class openstackclient.identity.v3.domain.CreateDomain(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new domain

get_parser(prog_name)
log = <logging.Logger object at 0x59fd050>
take_action(parsed_args)
class openstackclient.identity.v3.domain.DeleteDomain(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete domain

get_parser(prog_name)
log = <logging.Logger object at 0x59fd290>
take_action(parsed_args)
class openstackclient.identity.v3.domain.ListDomain(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List domains

log = <logging.Logger object at 0x59fd490>
take_action(parsed_args)
class openstackclient.identity.v3.domain.SetDomain(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set domain properties

get_parser(prog_name)
log = <logging.Logger object at 0x59fd690>
take_action(parsed_args)
class openstackclient.identity.v3.domain.ShowDomain(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display domain details

get_parser(prog_name)
log = <logging.Logger object at 0x59fd890>
take_action(parsed_args)

openstackclient.identity.v3.endpoint module

Identity v3 Endpoint action implementations

class openstackclient.identity.v3.endpoint.CreateEndpoint(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new endpoint

get_parser(prog_name)
log = <logging.Logger object at 0x631f2d0>
take_action(parsed_args)
class openstackclient.identity.v3.endpoint.DeleteEndpoint(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete endpoint

get_parser(prog_name)
log = <logging.Logger object at 0x631f250>
take_action(parsed_args)
class openstackclient.identity.v3.endpoint.ListEndpoint(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List endpoints

get_parser(prog_name)
log = <logging.Logger object at 0x631f510>
take_action(parsed_args)
class openstackclient.identity.v3.endpoint.SetEndpoint(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set endpoint properties

get_parser(prog_name)
log = <logging.Logger object at 0x631f110>
take_action(parsed_args)
class openstackclient.identity.v3.endpoint.ShowEndpoint(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display endpoint details

get_parser(prog_name)
log = <logging.Logger object at 0x631f950>
take_action(parsed_args)
openstackclient.identity.v3.endpoint.get_service_name(service)

openstackclient.identity.v3.federation_protocol module

Identity v3 Protocols actions implementations

class openstackclient.identity.v3.federation_protocol.CreateProtocol(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new federation protocol

get_parser(prog_name)
log = <logging.Logger object at 0x5acaf90>
take_action(parsed_args)
class openstackclient.identity.v3.federation_protocol.DeleteProtocol(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete federation protocol

get_parser(prog_name)
log = <logging.Logger object at 0x5acae10>
take_action(parsed_args)
class openstackclient.identity.v3.federation_protocol.ListProtocols(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List federation protocols

get_parser(prog_name)
log = <logging.Logger object at 0x5aca990>
take_action(parsed_args)
class openstackclient.identity.v3.federation_protocol.SetProtocol(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set federation protocol properties

get_parser(prog_name)
log = <logging.Logger object at 0x5aca8d0>
take_action(parsed_args)
class openstackclient.identity.v3.federation_protocol.ShowProtocol(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display federation protocol details

get_parser(prog_name)
log = <logging.Logger object at 0x5aca090>
take_action(parsed_args)

openstackclient.identity.v3.group module

Group action implementations

class openstackclient.identity.v3.group.AddUserToGroup(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Add user to group

get_parser(prog_name)
log = <logging.Logger object at 0x5b1df10>
take_action(parsed_args)
class openstackclient.identity.v3.group.CheckUserInGroup(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Check user membership in group

get_parser(prog_name)
log = <logging.Logger object at 0x634bc10>
take_action(parsed_args)
class openstackclient.identity.v3.group.CreateGroup(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new group

get_parser(prog_name)
log = <logging.Logger object at 0x634bad0>
take_action(parsed_args)
class openstackclient.identity.v3.group.DeleteGroup(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete group(s)

get_parser(prog_name)
log = <logging.Logger object at 0x5ae23d0>
take_action(parsed_args)
class openstackclient.identity.v3.group.ListGroup(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List groups

get_parser(prog_name)
log = <logging.Logger object at 0x5ae2c90>
take_action(parsed_args)
class openstackclient.identity.v3.group.RemoveUserFromGroup(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Remove user from group

get_parser(prog_name)
log = <logging.Logger object at 0x5af7e90>
take_action(parsed_args)
class openstackclient.identity.v3.group.SetGroup(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set group properties

get_parser(prog_name)
log = <logging.Logger object at 0x5af7950>
take_action(parsed_args)
class openstackclient.identity.v3.group.ShowGroup(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display group details

get_parser(prog_name)
log = <logging.Logger object at 0x5a62350>
take_action(parsed_args)

openstackclient.identity.v3.identity_provider module

Identity v3 IdentityProvider action implementations

class openstackclient.identity.v3.identity_provider.CreateIdentityProvider(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new identity provider

get_parser(prog_name)
log = <logging.Logger object at 0x55baf10>
take_action(parsed_args)
class openstackclient.identity.v3.identity_provider.DeleteIdentityProvider(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete identity provider

get_parser(prog_name)
log = <logging.Logger object at 0x672c210>
take_action(parsed_args)
class openstackclient.identity.v3.identity_provider.ListIdentityProvider(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List identity providers

log = <logging.Logger object at 0x672c690>
take_action(parsed_args)
class openstackclient.identity.v3.identity_provider.SetIdentityProvider(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set identity provider properties

get_parser(prog_name)
log = <logging.Logger object at 0x47c7850>
take_action(parsed_args)
class openstackclient.identity.v3.identity_provider.ShowIdentityProvider(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display identity provider details

get_parser(prog_name)
log = <logging.Logger object at 0x47c7c90>
take_action(parsed_args)

openstackclient.identity.v3.mapping module

Identity v3 federation mapping action implementations

class openstackclient.identity.v3.mapping.CreateMapping(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne, openstackclient.identity.v3.mapping._RulesReader

Create new mapping

get_parser(prog_name)
log = <logging.Logger object at 0x5f119d0>
take_action(parsed_args)
class openstackclient.identity.v3.mapping.DeleteMapping(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete mapping

get_parser(prog_name)
log = <logging.Logger object at 0x5f11250>
take_action(parsed_args)
class openstackclient.identity.v3.mapping.ListMapping(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List mappings

log = <logging.Logger object at 0x4993990>
take_action(parsed_args)
class openstackclient.identity.v3.mapping.SetMapping(app, app_args, cmd_name=None)

Bases: cliff.command.Command, openstackclient.identity.v3.mapping._RulesReader

Set mapping properties

get_parser(prog_name)
log = <logging.Logger object at 0x4993510>
take_action(parsed_args)
class openstackclient.identity.v3.mapping.ShowMapping(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display mapping details

get_parser(prog_name)
log = <logging.Logger object at 0x4993d10>
take_action(parsed_args)

openstackclient.identity.v3.policy module

Identity v3 Policy action implementations

class openstackclient.identity.v3.policy.CreatePolicy(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new policy

get_parser(prog_name)
log = <logging.Logger object at 0x5d81b50>
take_action(parsed_args)
class openstackclient.identity.v3.policy.DeletePolicy(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete policy

get_parser(prog_name)
log = <logging.Logger object at 0x5d81b90>
take_action(parsed_args)
class openstackclient.identity.v3.policy.ListPolicy(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List policies

get_parser(prog_name)
log = <logging.Logger object at 0x5d460d0>
take_action(parsed_args)
class openstackclient.identity.v3.policy.SetPolicy(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set policy properties

get_parser(prog_name)
log = <logging.Logger object at 0x5d462d0>
take_action(parsed_args)
class openstackclient.identity.v3.policy.ShowPolicy(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display policy details

get_parser(prog_name)
log = <logging.Logger object at 0x5d46750>
take_action(parsed_args)

openstackclient.identity.v3.project module

Project action implementations

class openstackclient.identity.v3.project.CreateProject(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new project

get_parser(prog_name)
log = <logging.Logger object at 0x5bd8210>
take_action(parsed_args)
class openstackclient.identity.v3.project.DeleteProject(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete project(s)

get_parser(prog_name)
log = <logging.Logger object at 0x5bd8450>
take_action(parsed_args)
class openstackclient.identity.v3.project.ListProject(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List projects

get_parser(prog_name)
log = <logging.Logger object at 0x5bd8650>
take_action(parsed_args)
class openstackclient.identity.v3.project.SetProject(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set project properties

get_parser(prog_name)
log = <logging.Logger object at 0x5bd8850>
take_action(parsed_args)
class openstackclient.identity.v3.project.ShowProject(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display project details

get_parser(prog_name)
log = <logging.Logger object at 0x5bd8a50>
take_action(parsed_args)

openstackclient.identity.v3.region module

Identity v3 Region action implementations

class openstackclient.identity.v3.region.CreateRegion(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new region

get_parser(prog_name)
log = <logging.Logger object at 0x6850f10>
take_action(parsed_args)
class openstackclient.identity.v3.region.DeleteRegion(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete region

get_parser(prog_name)
log = <logging.Logger object at 0x68509d0>
take_action(parsed_args)
class openstackclient.identity.v3.region.ListRegion(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List regions

get_parser(prog_name)
log = <logging.Logger object at 0x5c98d10>
take_action(parsed_args)
class openstackclient.identity.v3.region.SetRegion(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set region properties

get_parser(prog_name)
log = <logging.Logger object at 0x5ca0f90>
take_action(parsed_args)
class openstackclient.identity.v3.region.ShowRegion(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display region details

get_parser(prog_name)
log = <logging.Logger object at 0x5ca0510>
take_action(parsed_args)

openstackclient.identity.v3.role module

Identity v3 Role action implementations

class openstackclient.identity.v3.role.AddRole(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Adds a role to a user or group on a domain or project

get_parser(prog_name)
log = <logging.Logger object at 0x6031790>
take_action(parsed_args)
class openstackclient.identity.v3.role.CreateRole(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new role

get_parser(prog_name)
log = <logging.Logger object at 0x6031850>
take_action(parsed_args)
class openstackclient.identity.v3.role.DeleteRole(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete role(s)

get_parser(prog_name)
log = <logging.Logger object at 0x6031e10>
take_action(parsed_args)
class openstackclient.identity.v3.role.ListRole(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List roles

get_parser(prog_name)
log = <logging.Logger object at 0x5e5e310>
take_action(parsed_args)
class openstackclient.identity.v3.role.RemoveRole(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Remove role from domain/project : user/group

get_parser(prog_name)
log = <logging.Logger object at 0x5e5e550>
take_action(parsed_args)
class openstackclient.identity.v3.role.SetRole(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set role properties

get_parser(prog_name)
log = <logging.Logger object at 0x5e5e2d0>
take_action(parsed_args)
class openstackclient.identity.v3.role.ShowRole(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display role details

get_parser(prog_name)
log = <logging.Logger object at 0x5e5e5d0>
take_action(parsed_args)

openstackclient.identity.v3.role_assignment module

Identity v3 Assignment action implementations

class openstackclient.identity.v3.role_assignment.ListRoleAssignment(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List role assignments

get_parser(prog_name)
log = <logging.Logger object at 0x69ac590>
take_action(parsed_args)

openstackclient.identity.v3.service module

Identity v3 Service action implementations

class openstackclient.identity.v3.service.CreateService(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new service

get_parser(prog_name)
log = <logging.Logger object at 0x69fded0>
take_action(parsed_args)
class openstackclient.identity.v3.service.DeleteService(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete service

get_parser(prog_name)
log = <logging.Logger object at 0x6a0a150>
take_action(parsed_args)
class openstackclient.identity.v3.service.ListService(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List services

get_parser(prog_name)
log = <logging.Logger object at 0x6a0a350>
take_action(parsed_args)
class openstackclient.identity.v3.service.SetService(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set service properties

get_parser(prog_name)
log = <logging.Logger object at 0x6a0a550>
take_action(parsed_args)
class openstackclient.identity.v3.service.ShowService(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display service details

get_parser(prog_name)
log = <logging.Logger object at 0x6a0a750>
take_action(parsed_args)

openstackclient.identity.v3.token module

Identity v3 Token action implementations

class openstackclient.identity.v3.token.AuthorizeRequestToken(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Authorize a request token

get_parser(prog_name)
log = <logging.Logger object at 0x69f7a90>
take_action(parsed_args)
class openstackclient.identity.v3.token.CreateAccessToken(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create an access token

get_parser(prog_name)
log = <logging.Logger object at 0x69f78d0>
take_action(parsed_args)
class openstackclient.identity.v3.token.CreateRequestToken(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create a request token

get_parser(prog_name)
log = <logging.Logger object at 0x69f7350>
take_action(parsed_args)
class openstackclient.identity.v3.token.IssueToken(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Issue new token

get_parser(prog_name)
log = <logging.Logger object at 0x69f7310>
take_action(parsed_args)

openstackclient.identity.v3.trust module

Identity v3 Trust action implementations

class openstackclient.identity.v3.trust.CreateTrust(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new trust

get_parser(prog_name)
log = <logging.Logger object at 0x6b0f990>
take_action(parsed_args)
class openstackclient.identity.v3.trust.DeleteTrust(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete trust(s)

get_parser(prog_name)
log = <logging.Logger object at 0x6b0fbd0>
take_action(parsed_args)
class openstackclient.identity.v3.trust.ListTrust(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List trusts

log = <logging.Logger object at 0x6b0fdd0>
take_action(parsed_args)
class openstackclient.identity.v3.trust.ShowTrust(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display trust details

get_parser(prog_name)
log = <logging.Logger object at 0x6b0ffd0>
take_action(parsed_args)

openstackclient.identity.v3.unscoped_saml module

Identity v3 unscoped SAML auth action implementations.

The first step of federated auth is to fetch an unscoped token. From there, the user can list domains and projects they are allowed to access, and request a scoped token.

class openstackclient.identity.v3.unscoped_saml.ListAccessibleDomains(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List accessible domains

log = <logging.Logger object at 0x6ae8110>
take_action(parsed_args)
class openstackclient.identity.v3.unscoped_saml.ListAccessibleProjects(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List accessible projects

log = <logging.Logger object at 0x6ae8f90>
take_action(parsed_args)
openstackclient.identity.v3.unscoped_saml.auth_with_unscoped_saml(func)

Check the unscoped federated context

openstackclient.identity.v3.user module

Identity v3 User action implementations

class openstackclient.identity.v3.user.CreateUser(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Create new user

get_parser(prog_name)
log = <logging.Logger object at 0x6c1f550>
take_action(parsed_args)
class openstackclient.identity.v3.user.DeleteUser(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Delete user(s)

get_parser(prog_name)
log = <logging.Logger object at 0x6c1f790>
take_action(parsed_args)
class openstackclient.identity.v3.user.ListUser(app, app_args, cmd_name=None)

Bases: cliff.lister.Lister

List users

get_parser(prog_name)
log = <logging.Logger object at 0x6c1f990>
take_action(parsed_args)
class openstackclient.identity.v3.user.SetPasswordUser(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Change current user password

get_parser(prog_name)
log = <logging.Logger object at 0x6c1fd90>
take_action(parsed_args)
class openstackclient.identity.v3.user.SetUser(app, app_args, cmd_name=None)

Bases: cliff.command.Command

Set user properties

get_parser(prog_name)
log = <logging.Logger object at 0x6c1fb90>
take_action(parsed_args)
class openstackclient.identity.v3.user.ShowUser(app, app_args, cmd_name=None)

Bases: cliff.show.ShowOne

Display user details

get_parser(prog_name)
log = <logging.Logger object at 0x6c1ff90>
take_action(parsed_args)

Module contents