Service
class Service extends AbstractService implements IdentityService
Represents the Keystone v3 service.
Traits
Methods
No description
Authenticates and retrieves back a token and catalog.
Generates a new authentication token
Validates a token, identified by its ID, and returns TRUE if its valid, FALSE if not.
Revokes a token, identified by its ID. After this operation completes, users will not be able to use this token again for authentication.
Creates a new service according to the provided options.
Returns a generator which will yield a collection of service objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Retrieves a service object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
Creates a new endpoint according to the provided options.
Retrieves an endpoint object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
Returns a generator which will yield a collection of endpoint objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Creates a new domain according to the provided options.
Returns a generator which will yield a collection of domain objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Creates a new project according to the provided options.
Returns a generator which will yield a collection of project objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Retrieves a project object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
Creates a new user according to the provided options.
Returns a generator which will yield a collection of user objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Creates a new group according to the provided options.
Returns a generator which will yield a collection of group objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Creates a new credential according to the provided options.
Returns a generator which will yield a collection of credential objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Retrieves a credential object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
Creates a new role according to the provided options.
Returns a generator which will yield a collection of role objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Returns a generator which will yield a collection of role assignment objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Creates a new policy according to the provided options.
Returns a generator which will yield a collection of policy objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
Details
static factory(ClientInterface $client)
authenticate(array $options)
Authenticates and retrieves back a token and catalog.
generateToken(array $options)
Generates a new authentication token
getToken(string $id)
Retrieves a token object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
validateToken(string $id)
Validates a token, identified by its ID, and returns TRUE if its valid, FALSE if not.
revokeToken(string $id)
Revokes a token, identified by its ID. After this operation completes, users will not be able to use this token again for authentication.
createService(array $options)
Creates a new service according to the provided options.
listServices(array $options = array())
Returns a generator which will yield a collection of service objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
getService(string $id)
Retrieves a service object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
createEndpoint(array $options)
Creates a new endpoint according to the provided options.
getEndpoint(string $id)
Retrieves an endpoint object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
listEndpoints(array $options = array())
Returns a generator which will yield a collection of endpoint objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
createDomain(array $options)
Creates a new domain according to the provided options.
listDomains(array $options = array())
Returns a generator which will yield a collection of domain objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
getDomain(string $id)
Retrieves a domain object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
createProject(array $options)
Creates a new project according to the provided options.
listProjects(array $options = array())
Returns a generator which will yield a collection of project objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
getProject(string $id)
Retrieves a project object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
createUser(array $options)
Creates a new user according to the provided options.
listUsers(array $options = array())
Returns a generator which will yield a collection of user objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
getUser(string $id)
Retrieves a user object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
createGroup(array $options)
Creates a new group according to the provided options.
listGroups(array $options = array())
Returns a generator which will yield a collection of group objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
getGroup(string $id)
Retrieves a group object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
createCredential(array $options)
Creates a new credential according to the provided options.
listCredentials()
Returns a generator which will yield a collection of credential objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
getCredential(string $id)
Retrieves a credential object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.
createRole(array $options)
Creates a new role according to the provided options.
listRoles(array $options = array())
Returns a generator which will yield a collection of role objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
listRoleAssignments(array $options = array())
Returns a generator which will yield a collection of role assignment objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
createPolicy(array $options)
Creates a new policy according to the provided options.
listPolicies(array $options = array())
Returns a generator which will yield a collection of policy objects. The elements which generators yield can be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; you will need to use retrieve() to pull in the full state of the remote resource from the API.
getPolicy(string $id)
Retrieves a policy object and populates its unique identifier object. This operation will not perform a GET or HEAD request by default; you will need to call retrieve() if you want to pull in remote state from the API.