1. class
  2. OpenStack
  3. Identity
  4. v3
  5. Models
  6. Domain

Domain

class Domain extends OperatorResource implements Creatable, Listable, Retrievable, Updateable, Deletable

Traits

OpenStack\Common\Api\OperatorTrait

Properties

$id string
$name string
$links
$enabled bool
$description string

Methods

create (array $data) : Creatable

Create a new resource according to the configuration set in the options.

retrieve () : void

Retrieve details of the current resource from the remote API.

update () : void

Update the current resource with the configuration set out in the user options.

delete () : void

Permanently delete this resource.

listUserRoles (array $options = array()) : Generator

No description

grantUserRole (array $options = array())

No description

checkUserRole (array $options = array()) : bool

No description

revokeUserRole (array $options = array())

No description

listGroupRoles (array $options = array()) : Generator

No description

grantGroupRole (array $options = array())

No description

checkGroupRole (array $options = array()) : bool

No description

revokeGroupRole (array $options = array())

No description

Details

View source
create(array $data)

Create a new resource according to the configuration set in the options.

Parameters

$data array {see \OpenStack\Identity\v3\Api::postDomains}

Return value

Creatable

Example code

$creatable = $domain->create($data);

View source
retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$domain->retrieve();

View source
update()

Update the current resource with the configuration set out in the user options.

Return value

void

Example code

$domain->update();

View source
delete()

Permanently delete this resource.

Return value

void

Example code

$domain->delete();

View source
listUserRoles(array $options = array())

Parameters

$options array {see \OpenStack\Identity\v3\Api::getUserRoles}

Return value

Generator

Example code

$generator = $domain->listUserRoles($options);

View source
grantUserRole(array $options = array())

Parameters

$options array {see \OpenStack\Identity\v3\Api::putUserRoles}

Example code

$domain->grantUserRole($options);

View source
checkUserRole(array $options = array())

Parameters

$options array {see \OpenStack\Identity\v3\Api::headUserRole}

Return value

bool

Example code

$bool = $domain->checkUserRole($options);

View source
revokeUserRole(array $options = array())

Parameters

$options array {see \OpenStack\Identity\v3\Api::deleteUserRole}

Example code

$domain->revokeUserRole($options);

View source
listGroupRoles(array $options = array())

Parameters

$options array {see \OpenStack\Identity\v3\Api::getGroupRoles}

Return value

Generator

Example code

$generator = $domain->listGroupRoles($options);

View source
grantGroupRole(array $options = array())

Parameters

$options array {see \OpenStack\Identity\v3\Api::putGroupRole}

Example code

$domain->grantGroupRole($options);

View source
checkGroupRole(array $options = array())

Parameters

$options array {see \OpenStack\Identity\v3\Api::headGroupRole}

Return value

bool

Example code

$bool = $domain->checkGroupRole($options);

View source
revokeGroupRole(array $options = array())

Parameters

$options array {see \OpenStack\Identity\v3\Api::deleteGroupRole}

Example code

$domain->revokeGroupRole($options);