openstackclient.identity.v3 package¶
Submodules¶
openstackclient.identity.v3.catalog module¶
Identity v3 Service Catalog action implementations
openstackclient.identity.v3.consumer module¶
Identity v3 Consumer action implementations
-
class
openstackclient.identity.v3.consumer.CreateConsumer(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ShowOneCreate new consumer
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.consumer.DeleteConsumer(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete consumer(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.consumer.ListConsumer(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList consumers
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new credential
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.credential.DeleteCredential(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete credential(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.credential.ListCredential(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList credentials
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new domain
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.domain.DeleteDomain(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete domain(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.domain.ListDomain(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList domains
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
openstackclient.identity.v3.ec2creds module¶
Identity v3 EC2 Credentials action implementations
-
class
openstackclient.identity.v3.ec2creds.CreateEC2Creds(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ShowOneCreate EC2 credentials
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.ec2creds.DeleteEC2Creds(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete EC2 credentials
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new endpoint
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.endpoint.DeleteEndpoint(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete endpoint(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.endpoint.ListEndpoint(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList endpoints
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.endpoint.SetEndpoint(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandSet endpoint properties
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.endpoint.ShowEndpoint(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ShowOneDisplay endpoint details
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new federation protocol
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.federation_protocol.DeleteProtocol(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete federation protocol(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.federation_protocol.ListProtocols(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList federation protocols
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.CommandAdd user to group
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.group.CheckUserInGroup(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandCheck user membership in group
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.group.CreateGroup(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ShowOneCreate new group
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.group.DeleteGroup(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete group(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.group.ListGroup(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList groups
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.group.RemoveUserFromGroup(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandRemove user from group
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new identity provider
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.identity_provider.DeleteIdentityProvider(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete identity provider(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.identity_provider.ListIdentityProvider(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList identity providers
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOne,openstackclient.identity.v3.mapping._RulesReaderCreate new mapping
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.mapping.DeleteMapping(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete mapping(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.mapping.ListMapping(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList mappings
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new policy
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.policy.DeletePolicy(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete policy(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.policy.ListPolicy(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList policies
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new project
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.project.DeleteProject(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete project(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.project.ListProject(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList projects
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new region
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.region.DeleteRegion(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete region(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.region.ListRegion(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList regions
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.CommandAdds a role assignment to a user or group on a domain or project
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.role.CreateRole(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ShowOneCreate new role
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.role.DeleteRole(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete role(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.role.ListRole(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList roles
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.role.RemoveRole(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandRemoves a role assignment from domain/project : user/group
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
openstackclient.identity.v3.role_assignment module¶
Identity v3 Assignment action implementations
openstackclient.identity.v3.service module¶
Identity v3 Service action implementations
-
class
openstackclient.identity.v3.service.CreateService(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ShowOneCreate new service
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.service.DeleteService(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete service(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.service.ListService(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList services
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
openstackclient.identity.v3.service_provider module¶
Service Provider action implementations
-
class
openstackclient.identity.v3.service_provider.CreateServiceProvider(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ShowOneCreate new service provider
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.service_provider.DeleteServiceProvider(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete service provider(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.service_provider.ListServiceProvider(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList service providers
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneAuthorize a request token
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.token.CreateAccessToken(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ShowOneCreate an access token
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.token.CreateRequestToken(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ShowOneCreate a request token
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new trust
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.trust.DeleteTrust(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete trust(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ListerList accessible domains
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.unscoped_saml.ListAccessibleProjects(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList accessible projects
-
log= <logging.Logger object>¶
-
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:
osc_lib.command.command.ShowOneCreate new user
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.user.DeleteUser(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandDelete user(s)
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.user.ListUser(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.ListerList users
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
take_action(parsed_args)¶
-
-
class
openstackclient.identity.v3.user.SetPasswordUser(app, app_args, cmd_name=None)¶ Bases:
osc_lib.command.command.CommandChange current user password
-
get_parser(prog_name)¶
-
log= <logging.Logger object>¶
-
required_scope= False¶
-
take_action(parsed_args)¶
-