CloudObjects / Directory / CloudObjects / DomainRelationsAPI 1.0
Sign in

DomainRelationsAPI 1.0

a agws:WebAPI in CloudObjects
API Methods

These are the methods supported by the API:

  • GET / List Domains

    Returns the list of domains that the authorized user has access to.

  • GET /{hostname} Domain Info

    Returns basic information about the domain.

    Optional parameters:
    embed Embeds additional information. Supported values are verification, members, consumers and providers; multiple can be provided separated by commas.
  • PUT /{hostname} Add Domain

    Adds a new domain to the user's account. Only existing hostnames that have not already been registered by another user or the test domain {aauid}.aauid.net can be added.

  • DELETE /{hostname} Remove Domain

    Removes a domain from CloudObjects. All objects inside the namespace except the root object must be deleted before the domain can be removed.

  • GET /{hostname}/verification Verification Info

    Returns information about whether and how control of this domain was verified.

  • POST /{hostname}/verification Verify Domain Control

    Starts or completes a domain verification process.

    Optional parameters:
    method The method through which domain control should be verified. This parameter is required when starting a new process and ignored if a started process can be completed.
  • GET /{hostname}/members List members

    List all the accounts that are members of this domain along with their roles.

  • GET /{hostname}/members/{aauid} Get member of domain

    Checks whether the account with the given AAUID is a member of this domain and returns the role.

  • PUT /{hostname}/members/{aauid} Add member to domain

    Adds the account with the given AAUID as a member to this domain or updates the role. Expects parameter 'role' in the request body.

  • DELETE /{hostname}/members/{aauid} Remove member from domain

    Removes the account with the given AAUID as a member of this domain. It is not possible to remove oneself.

  • GET /{hostname}/consumers List consumers

    List all the domains that are associated consumers of this domain along with their roles.

  • GET /{hostname}/consumers/{hostname2} Get consumer of domain

    Checks whether the second domain is a consumer of the first domain and returns the role.

  • PUT /{hostname}/consumers/{hostname2} Add consumer to domain

    Associates the second domain as a consumer of the first domain or updates the role. Expects parameter 'role' in the request body.

  • DELETE /{hostname}/consumers/{hostname2} Remove consumer from domain

    Removes the consumer association of two domains.

  • GET /{hostname}/providers List providers

    List all the domains that are associated providers of this domain along with their roles.

  • GET /{hostname}/providers/{hostname2} Get provider of domain

    Checks whether the second domain is a provider of the first domain and returns the role.

  • DELETE /{hostname}/providers/{hostname2} Remove provider from domain

    Removes the provider association of two domains.

Meta
URI / COID
coid://cloudobjects.io/DomainRelationsAPI/1.0
Revision
4-983c97668b9cd1997dd50053eb97e3ed
Last updated
2017-04-20 14:00 (UTC)
Created at
2017-11-21 11:44 (UTC)
Usage permission
Public