index.md

CloudShell Administration REST API

This API enables developers to perform CloudShell administration tasks. This includes managing CloudShell users, groups, domains, license pools, associating resources and blueprints to other domains, and more.

The following Administration APIs are available:

Login:

• Get Administration API token

Domains:

Manage CloudShell domains.

• Get all domains
• Create domain
• Get domain by ID
• Edit domain
• Delete domain

DomainBlueprints:

Manage a domain's blueprints.

• Get domain's blueprints
• Add blueprints to domain
• Remove blueprints from domain

DomainGroups:

Manage a domain's group associations.

• Get domain's groups
• Add groups to domain
• Remove groups from domain

DomainResources:

Manage a domain's resources.

• Get domain's resources
• Add resources to domain
• Remove resources from domain

Groups:

Manage CloudShell groups.

• Get all groups
• Create group
• Get group by ID
• Edit group
• Delete group

GroupDomains:

Manage a group's domain associations.

• Get group's domains
• Add domains to group
• Remove domains from group

GroupUsers:

Manage a group's users.

• Get group's users
• Add users to group
• Remove users from group

Users:

Manage CloudShell users.

• Get all users
• Get user by ID
• Create user
• Edit user
• Delete user

IdentityManagement:

Get and import users from your active directory or LDAP.

• Get all external groups
• Get users from an external group
• Import external users

LicensePools:

Manage CloudShell license pools.

• Get all license pools
• Get license pool by ID
• Create license pool
• Edit license pool
• Delete license pool