Introduction

Authorisation using AAP is carried out via Domains and User Membership. A given RESTful microservice will be represented within AAP by a series of domains.

Each domain within a service can be then considered as a role by which its members are authorised to perform specified actions defined by the service.

Resources

Domain

The Domain resource represents a permission/group/scope. It maintains permissions/scope to access other services.

The users can perform Create/Update/Delete/GET operations on this resource.

Create domain

  • Self domain:

There are no restrictions to create a self domain. Anyone can create a domain without restrictions. You can create a domain(group)by sending a 'POST' request. You would become a manager(maintainer)of the domain if you create a domain.

Example: self.test-domain.

  • Prefix domain: To create a prefix domain, user must be a member of prefix admin domain.

Example: To create 'usi.submitters' domain, user must be a member of 'aap.usi.admin' domain. This prefix admin domain(aap.usi.admin) would create in the AAP system based on user request.

Please contact us to create your prefix admin domain and it’s membership.

Example request

http
POST /domains HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk

{"domainName":"new domain","domainDesc":"new domain Desc"}
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json' \
    -d '{"domainName":"new domain","domainDesc":"new domain Desc"}'
httpie
$ echo '{"domainName":"new domain","domainDesc":"new domain Desc"}' | http POST 'https://explore.api.aai.ebi.ac.uk/domains' \
    'Content-Type:application/json;charset=UTF-8' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 201 Created
Content-Type: application/hal+json;charset=utf-8
Content-Length: 769

{
  "domainName" : "self.new domain",
  "domainDesc" : "new domain Desc",
  "domainReference" : "dom-11824a99-16cc-4c1c-bfbb-4e1b2d11623f",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11824a99-16cc-4c1c-bfbb-4e1b2d11623f"
    },
    "deactivate" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11824a99-16cc-4c1c-bfbb-4e1b2d11623f"
    },
    "get users from domain" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11824a99-16cc-4c1c-bfbb-4e1b2d11623f/users"
    },
    "admin" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-383aed32-6d2b-4caf-875a-e741598e7889"
    },
    "get all domains" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains"
    }
  }
}

Get domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • aap.domain.view domain member

  • member/manager of the domain

Send a 'GET' request to access the domain details.

Example request

http
GET /domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80 HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 759

{
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "deactivate" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "get users from domain" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
    },
    "admin" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
    },
    "get all domains" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains"
    }
  }
}

Delete Domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • manager of the domain

Send a 'DELETE' request to deactivate the domain. At present, the System would not delete the domain permanently but it will mark it as inactive. Inactive domains are automatically filtered out of all requests. So you can see only active domains and they’ll be flagged via: isActive -Y → active, N → inactive.

Example request

http
DELETE /domains/dom-63961448-eb85-4753-99e9-d945d1e3543c HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-63961448-eb85-4753-99e9-d945d1e3543c' -i -X DELETE \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http DELETE 'https://explore.api.aai.ebi.ac.uk/domains/dom-63961448-eb85-4753-99e9-d945d1e3543c' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 752

{
  "domainName" : "test",
  "domainDesc" : "Delete me",
  "domainReference" : "dom-63961448-eb85-4753-99e9-d945d1e3543c",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-63961448-eb85-4753-99e9-d945d1e3543c"
    },
    "deactivate" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-63961448-eb85-4753-99e9-d945d1e3543c"
    },
    "get users from domain" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-63961448-eb85-4753-99e9-d945d1e3543c/users"
    },
    "admin" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-c42bd6ac-f6ea-4d63-a322-2b13afd675ae"
    },
    "get all domains" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains"
    }
  }
}

Update Domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • manager of the domain

Send a 'PUT' request to update the domain. This update endpoint allows the user to update only 'domain description' not other domain details like domain name, domain reference…​ etc. But it would not give any error info if the user provides domain name, reference along with domain description as part of the input body to update. It would just consider domain description to update and rest would ignore.

Example request

http
PUT /domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk

{"domainDesc":"updateDesc"}
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json' \
    -d '{"domainDesc":"updateDesc"}'
httpie
$ echo '{"domainDesc":"updateDesc"}' | http PUT 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80' \
    'Content-Type:application/json;charset=UTF-8' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 759

{
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "deactivate" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "get users from domain" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
    },
    "admin" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
    },
    "get all domains" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains"
    }
  }
}

Get All Domains

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • aap.domain.view domain member

To see all the aap domains you should satisfy above authorisation.

Send a 'GET' request to list all the domains.

Example request

http
GET /domains HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/domains' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 18182

[ {
  "domainName" : "aap.admin",
  "domainDesc" : "Grants all permissions on all endpoints",
  "domainReference" : "dom-22cd5f5a-2f37-4396-ab39-131781ecd6d8",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22cd5f5a-2f37-4396-ab39-131781ecd6d8"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22cd5f5a-2f37-4396-ab39-131781ecd6d8"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22cd5f5a-2f37-4396-ab39-131781ecd6d8/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-2802e0f1-6662-486e-bfe3-5b3f7beb7b10"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.burton.admin",
  "domainDesc" : "/Tim/ burton prefix regular domain",
  "domainReference" : "dom-76a8e93c-3983-11e8-b467-0ed5f89f718b",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-76a8e93c-3983-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-76a8e93c-3983-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-76a8e93c-3983-11e8-b467-0ed5f89f718b/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b4f5b580-3983-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.domain.view",
  "domainDesc" : "Allows members to see the list of domains",
  "domainReference" : "dom-b75ff7f4-d649-4a57-b554-137b22c88619",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9c2d4fd1-daa3-4cb4-b118-4d2d746eaf33"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.profile.search",
  "domainDesc" : "Allows members to search the users by attributes key and value",
  "domainReference" : "dom-4fa97e85-8934-4ffe-94ef-c46dbb119ec2",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4fa97e85-8934-4ffe-94ef-c46dbb119ec2"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4fa97e85-8934-4ffe-94ef-c46dbb119ec2"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4fa97e85-8934-4ffe-94ef-c46dbb119ec2/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-d5c43201-ef37-4a23-899e-4965aac48d2d"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.rd1.admin",
  "domainDesc" : "pfxdom1",
  "domainReference" : "dom-11111111-1111-1111-1111-111111111113",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11111111-1111-1111-1111-111111111113"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11111111-1111-1111-1111-111111111113"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11111111-1111-1111-1111-111111111113/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11111111-1111-1111-1111-111111111114"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.rd2.admin",
  "domainDesc" : "pfxdom2",
  "domainReference" : "dom-22222222-2222-2222-2222-222222222223",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22222222-2222-2222-2222-222222222223"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22222222-2222-2222-2222-222222222223"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22222222-2222-2222-2222-222222222223/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22222222-2222-2222-2222-222222222224"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.rd3.admin",
  "domainDesc" : "pfxdom3",
  "domainReference" : "dom-33333333-3333-3333-3333-333333333333",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-33333333-3333-3333-3333-333333333333"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-33333333-3333-3333-3333-333333333333"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-33333333-3333-3333-3333-333333333333/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-33333333-3333-3333-3333-333333333334"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.token.extend",
  "domainDesc" : "Allows members to request long-lived tokens",
  "domainReference" : "dom-ad0681d6-e9a8-4a96-822a-6976ae7e24fb",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-ad0681d6-e9a8-4a96-822a-6976ae7e24fb"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-ad0681d6-e9a8-4a96-822a-6976ae7e24fb"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-ad0681d6-e9a8-4a96-822a-6976ae7e24fb/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4f907612-3531-4e38-a334-510eb1b8213f"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.user.view",
  "domainDesc" : "Allows members to see the list of users and details of any user",
  "domainReference" : "dom-14f96c49-f13a-437f-baf2-57ff0a2818a8",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e98a4c45-1afa-408d-afcf-d92c326c8107"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "burton.corpse-bride",
  "domainDesc" : "Yet to be watched",
  "domainReference" : "dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-a95ffc0a-3981-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "EGAAdmin",
  "domainDesc" : "EGA Admin Description",
  "domainReference" : "dom-4df7aa34-2eb5-4b8a-850b-e19dae26582e",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4df7aa34-2eb5-4b8a-850b-e19dae26582e"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4df7aa34-2eb5-4b8a-850b-e19dae26582e"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4df7aa34-2eb5-4b8a-850b-e19dae26582e/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-67518a98-3b9d-4a42-8d4f-802fd88433c5"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "EGAManagement",
  "domainDesc" : "EGA Management Description",
  "domainReference" : "dom-9c24b295-ac56-4c14-932f-dfccae25da10",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9c24b295-ac56-4c14-932f-dfccae25da10"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9c24b295-ac56-4c14-932f-dfccae25da10"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9c24b295-ac56-4c14-932f-dfccae25da10/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b1355411-9757-45df-845d-799b6b8f4d71"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "EGAReviewer",
  "domainDesc" : "EGA Reviewers Description",
  "domainReference" : "dom-e65725c3-3534-4a22-965f-a35b9ef8cacf",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e65725c3-3534-4a22-965f-a35b9ef8cacf"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e65725c3-3534-4a22-965f-a35b9ef8cacf"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e65725c3-3534-4a22-965f-a35b9ef8cacf/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-eb336d4e-8558-4aef-aa53-65dd68af30e3"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "EGASubmission",
  "domainDesc" : "EGA Submission Description",
  "domainReference" : "dom-4c44ebc2-edea-4136-895a-d5e878225bcd",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4c44ebc2-edea-4136-895a-d5e878225bcd"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4c44ebc2-edea-4136-895a-d5e878225bcd"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-4c44ebc2-edea-4136-895a-d5e878225bcd/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-aea8f20d-5e79-4637-9ed4-43a550eff9a4"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "PRIDEAdmin",
  "domainDesc" : "PRIDE Admin Description",
  "domainReference" : "dom-47dc1f8a-495a-44bf-9de7-d3d449800bdb",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-47dc1f8a-495a-44bf-9de7-d3d449800bdb"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-47dc1f8a-495a-44bf-9de7-d3d449800bdb"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-47dc1f8a-495a-44bf-9de7-d3d449800bdb/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-a611f5fd-ed34-489c-900a-fd716cf679ab"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "PRIDEReviewer",
  "domainDesc" : "PRIDE Reviewers Description",
  "domainReference" : "dom-2c74e900-fbba-4cde-b780-55d6e81a8488",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-2c74e900-fbba-4cde-b780-55d6e81a8488"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-2c74e900-fbba-4cde-b780-55d6e81a8488"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-2c74e900-fbba-4cde-b780-55d6e81a8488/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-27872bae-c02a-4536-854a-2a8bb88ce31b"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "PRIDESubmission",
  "domainDesc" : "PRIDE Submission Description",
  "domainReference" : "dom-e0ab367a-dab0-4a84-b983-25faec4595da",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e0ab367a-dab0-4a84-b983-25faec4595da"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e0ab367a-dab0-4a84-b983-25faec4595da"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e0ab367a-dab0-4a84-b983-25faec4595da/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-c3ae99f8-4c30-4822-8538-afb32a5d9257"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "rd1.subdom",
  "domainDesc" : "regdom1",
  "domainReference" : "dom-11111111-1111-1111-1111-111111111111",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11111111-1111-1111-1111-111111111111"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11111111-1111-1111-1111-111111111111"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11111111-1111-1111-1111-111111111111/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-11111111-1111-1111-1111-111111111112"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "rd2.subdom",
  "domainDesc" : "regdom2",
  "domainReference" : "dom-22222222-2222-2222-2222-222222222221",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22222222-2222-2222-2222-222222222221"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22222222-2222-2222-2222-222222222221"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22222222-2222-2222-2222-222222222221/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-22222222-2222-2222-2222-222222222222"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "rd3.subdom",
  "domainDesc" : "regdom3",
  "domainReference" : "dom-33333333-3333-3333-3333-333333333331",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-33333333-3333-3333-3333-333333333331"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-33333333-3333-3333-3333-333333333331"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-33333333-3333-3333-3333-333333333331/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-33333333-3333-3333-3333-333333333332"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "self.test domain1",
  "domainDesc" : "test domain1 Desc",
  "domainReference" : "dom-e3bdaf68-6429-4a09-a529-9023a94fbbd9",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e3bdaf68-6429-4a09-a529-9023a94fbbd9"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e3bdaf68-6429-4a09-a529-9023a94fbbd9"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e3bdaf68-6429-4a09-a529-9023a94fbbd9/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-0192f4ed-36ac-4bdc-bf16-2d5710c10309"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "willy-wonka",
  "domainDesc" : "The chocolate factory",
  "domainReference" : "dom-6b3c0b7d-1530-445a-859a-94c05b9c0a88",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-6b3c0b7d-1530-445a-859a-94c05b9c0a88"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-6b3c0b7d-1530-445a-859a-94c05b9c0a88"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-6b3c0b7d-1530-445a-859a-94c05b9c0a88/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-1aa78e94-6b39-4632-85a8-3112cc3ee96d"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
} ]

Add a user to the domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • manager of the domain

A manager or aap admin can give domain membership to any user. But to get a membership the user should exist in the AAP.

Send a 'PUT' request to add a user to the domain.

Example request

http
PUT /domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4/user HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4/user' -i -X PUT \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http PUT 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4/user' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 1335

{
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "users" : [ {
    "userName" : "karo",
    "email" : "karo@example.com",
    "userReference" : "usr-b070585b-a340-4a98-aff1-f3de48da8c38",
    "_links" : {
      "self" : {
        "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38"
      }
    }
  }, {
    "userName" : "ajay",
    "email" : "ajay@example.com",
    "userReference" : "usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4",
    "_links" : {
      "self" : {
        "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4"
      }
    }
  } ],
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "deactivate" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "get users from domain" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
    },
    "admin" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
    },
    "get all domains" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains"
    }
  }
}

Find a user membership

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • aap.domain.view domain member

  • member/manager of the domain

Send a 'GET' request to find out given user is a member of a given domain or not. ==== Example request

http
GET /domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/karo/status HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/karo/status' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/karo/status' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 4

true

Get users from the domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • aap.domain.view domain member

  • member/manager of the domain

Send a 'GET' request to see all the members of the domain.

Example request

http
GET /domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 526

[ {
  "userName" : "karo",
  "email" : "karo@example.com",
  "userReference" : "usr-b070585b-a340-4a98-aff1-f3de48da8c38",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38"
  } ]
}, {
  "userName" : "ajay",
  "email" : "ajay@example.com",
  "userReference" : "usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4"
  } ]
} ]

Delete a user from the domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • manager of the domain to remove other users.

  • But you can delete yourself from the domain as a member of the domain.

Send a 'DELETE' request to remove yourself from the domain. As an AAP admin or manager send a 'DELETE' request to remove other users from the domain.

Example request

http
DELETE /domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4/user HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4/user' -i -X DELETE \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http DELETE 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4/user' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 1055

{
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "users" : [ {
    "userName" : "karo",
    "email" : "karo@example.com",
    "userReference" : "usr-b070585b-a340-4a98-aff1-f3de48da8c38",
    "_links" : {
      "self" : {
        "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38"
      }
    }
  } ],
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "deactivate" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "get users from domain" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
    },
    "admin" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
    },
    "get all domains" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains"
    }
  }
}

Get managers from the domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • manager of the domain

Send a 'GET' request to see all the managers of the domain.

Example request

http
GET /domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/managers HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/managers' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/managers' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 526

[ {
  "userName" : "karo",
  "email" : "karo@example.com",
  "userReference" : "usr-b070585b-a340-4a98-aff1-f3de48da8c38",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38"
  } ]
}, {
  "userName" : "ajay",
  "email" : "ajay@example.com",
  "userReference" : "usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4"
  } ]
} ]

Add a manager to the domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • manager of the domain

Send a 'PUT' request to add manager to the domain.

Example request

http
PUT /domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/managers/usr-98ff3259-cc2e-45d4-87e0-aee951f8bc25 HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/managers/usr-98ff3259-cc2e-45d4-87e0-aee951f8bc25' -i -X PUT \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http PUT 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/managers/usr-98ff3259-cc2e-45d4-87e0-aee951f8bc25' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 1337

{
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "managers" : [ {
    "userName" : "test3",
    "email" : "test3@test.com",
    "userReference" : "usr-98ff3259-cc2e-45d4-87e0-aee951f8bc25",
    "_links" : {
      "self" : {
        "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-98ff3259-cc2e-45d4-87e0-aee951f8bc25"
      }
    }
  }, {
    "userName" : "karo",
    "email" : "karo@example.com",
    "userReference" : "usr-b070585b-a340-4a98-aff1-f3de48da8c38",
    "_links" : {
      "self" : {
        "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38"
      }
    }
  } ],
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "deactivate" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "get users from domain" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
    },
    "admin" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
    },
    "get all domains" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains"
    }
  }
}

Delete a manager from the domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • manager of the domain

As a manager/AAP admin you can delete other managers, only if that domain contains more than one manager. Otherwise you will see 'UnsupportedOperationException' exception.

Send a 'DELETE' request to delete a manager from the domain.

Example request

http
DELETE /domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/managers/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4 HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/managers/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4' -i -X DELETE \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http DELETE 'https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/managers/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 1058

{
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "managers" : [ {
    "userName" : "karo",
    "email" : "karo@example.com",
    "userReference" : "usr-b070585b-a340-4a98-aff1-f3de48da8c38",
    "_links" : {
      "self" : {
        "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38"
      }
    }
  } ],
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "deactivate" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
    },
    "get users from domain" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
    },
    "admin" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
    },
    "get all domains" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains"
    }
  }
}

Get your membership domains

Authorisation:

  • User must be a member of the domain.

User can see his membership domains details.

Send a 'GET' request to see your membership domains.

Example request

http
GET /my/domains HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/my/domains' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/my/domains' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 2413

[ {
  "domainName" : "aap.user.view",
  "domainDesc" : "Allows members to see the list of users and details of any user",
  "domainReference" : "dom-14f96c49-f13a-437f-baf2-57ff0a2818a8",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e98a4c45-1afa-408d-afcf-d92c326c8107"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.domain.view",
  "domainDesc" : "Allows members to see the list of domains",
  "domainReference" : "dom-b75ff7f4-d649-4a57-b554-137b22c88619",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9c2d4fd1-daa3-4cb4-b118-4d2d746eaf33"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
} ]

Get your management domains

Authorisation:

  • User must be a manager of the domain.

User can see his management domains details.

Send a 'GET' request to see your manager(management)domains.

Example request

http
GET /my/management HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/my/management' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/my/management' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 3154

[ {
  "domainName" : "burton.corpse-bride",
  "domainDesc" : "Yet to be watched",
  "domainReference" : "dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-a95ffc0a-3981-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.burton.admin",
  "domainDesc" : "/Tim/ burton prefix regular domain",
  "domainReference" : "dom-76a8e93c-3983-11e8-b467-0ed5f89f718b",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-76a8e93c-3983-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-76a8e93c-3983-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-76a8e93c-3983-11e8-b467-0ed5f89f718b/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b4f5b580-3983-11e8-b467-0ed5f89f718b"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "self.test domain1",
  "domainDesc" : "test domain1 Desc",
  "domainReference" : "dom-e3bdaf68-6429-4a09-a529-9023a94fbbd9",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e3bdaf68-6429-4a09-a529-9023a94fbbd9"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e3bdaf68-6429-4a09-a529-9023a94fbbd9"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e3bdaf68-6429-4a09-a529-9023a94fbbd9/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-0192f4ed-36ac-4bdc-bf16-2d5710c10309"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
} ]

Get prefix domain for a domain

Authorisation: You must be any of:

  • aap.admin domain member(AAP admin)

  • aap.domain.view domain member

  • requested domain member/manager and in the same time prefix domain member/manager

Send a 'GET' request to the endpoint, Returns a domain representing a prefix for a requested domain ID. The method first attempts to find a domain using provided ID. If the domain is found and has/belongs to a prefix, the method then tries to get the domain representing the prefix. If it succeeds, the prefix domain is returned as a result.

HTTP status codes

Status code Usage

200 OK
Success. Body contains prefix domain object.

204 No Content
Domain with a given ID exists, but has no prefix or no corresponding prefix domain exists for a given prefix.

404 Not Found
No domain found for given ID.

Example request

http
GET /domains/dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b/prefix HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/domains/dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b/prefix' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/domains/dom-9ac97d1a-3981-11e8-b467-0ed5f89f718b/prefix' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 789

{
  "domainName" : "aap.burton.admin",
  "domainDesc" : "/Tim/ burton prefix regular domain",
  "domainReference" : "dom-76a8e93c-3983-11e8-b467-0ed5f89f718b",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-76a8e93c-3983-11e8-b467-0ed5f89f718b"
    },
    "deactivate" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-76a8e93c-3983-11e8-b467-0ed5f89f718b"
    },
    "get users from domain" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-76a8e93c-3983-11e8-b467-0ed5f89f718b/users"
    },
    "admin" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b4f5b580-3983-11e8-b467-0ed5f89f718b"
    },
    "get all domains" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/domains"
    }
  }
}

User

The User resource represents a person in the AAP system. For both types of users (federated/LS AAI or local/AAP), their permissions will be determined by their membership in different groups, that we refer to as domains (alternatively we could use the term roles). An individual user can then be added in as a member of different domains by individual domain managers as required to access other resources.

Get user(by user reference)

Authorisation:

-User can see his/her own details.

-Others must be any of:

  • aap.admin domain member(AAP admin)

  • aap.user.view domain member

Send a 'GET' request to get user by user reference.

Example request

http
GET /users/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4 HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/users/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/users/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 260

{
  "userName" : "ajay",
  "email" : "ajay@example.com",
  "userReference" : "usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4"
    }
  }
}

Get user(by username)

Authorisation:

-User can see his/her own details.

-Others must be any of:

  • aap.admin domain member(AAP admin)

  • aap.user.view domain member

Send a 'GET' request to get user by username.

Example request

http
GET /users/karo HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/users/karo' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/users/karo' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 260

{
  "userName" : "karo",
  "email" : "karo@example.com",
  "userReference" : "usr-b070585b-a340-4a98-aff1-f3de48da8c38",
  "_links" : {
    "self" : {
      "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38"
    }
  }
}

Get all user domains(by user reference)

Authorisation:

-User can see his/her own details.

-Others must be any of:

  • aap.admin domain member(AAP admin)

  • aap.user.view domain member

Send a 'GET' request to see all the membership domains by user reference.

Example request

http
GET /users/usr-b070585b-a340-4a98-aff1-f3de48da8c38/domains HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38/domains' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38/domains' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 2413

[ {
  "domainName" : "aap.user.view",
  "domainDesc" : "Allows members to see the list of users and details of any user",
  "domainReference" : "dom-14f96c49-f13a-437f-baf2-57ff0a2818a8",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e98a4c45-1afa-408d-afcf-d92c326c8107"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.domain.view",
  "domainDesc" : "Allows members to see the list of domains",
  "domainReference" : "dom-b75ff7f4-d649-4a57-b554-137b22c88619",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9c2d4fd1-daa3-4cb4-b118-4d2d746eaf33"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
} ]

Get all user domains(by username)

Authorisation:

-User can see his/her own details.

-Others must be any of:

  • aap.admin domain member(AAP admin)

  • aap.user.view domain member

Send a 'GET' request to see all the membership domains by username.

Example request

http
GET /users/karo/domains HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/users/karo/domains' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/users/karo/domains' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 2413

[ {
  "domainName" : "aap.user.view",
  "domainDesc" : "Allows members to see the list of users and details of any user",
  "domainReference" : "dom-14f96c49-f13a-437f-baf2-57ff0a2818a8",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-14f96c49-f13a-437f-baf2-57ff0a2818a8/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-e98a4c45-1afa-408d-afcf-d92c326c8107"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "wonderland",
  "domainDesc" : "updateDesc",
  "domainReference" : "dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-36ccaae5-1ce1-41f9-b65c-d349994e9c80/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-7c3aa7d3-e9bc-43e5-818a-8971390a3102"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
}, {
  "domainName" : "aap.domain.view",
  "domainDesc" : "Allows members to see the list of domains",
  "domainReference" : "dom-b75ff7f4-d649-4a57-b554-137b22c88619",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619"
  }, {
    "rel" : "deactivate",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619"
  }, {
    "rel" : "get users from domain",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-b75ff7f4-d649-4a57-b554-137b22c88619/users"
  }, {
    "rel" : "admin",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains/dom-9c2d4fd1-daa3-4cb4-b118-4d2d746eaf33"
  }, {
    "rel" : "get all domains",
    "href" : "https://explore.api.aai.ebi.ac.uk/domains"
  } ]
} ]

Get all AAP users

Authorisation:

-You must be any of:

  • aap.admin domain member(AAP admin)

  • aap.user.view domain member

Send a 'GET' request to see all the AAP users.

Example request

http
GET /users HTTP/1.1
Authorization: Bearer eyJhb...h7HgQ
Accept: application/hal+json
Host: explore.api.aai.ebi.ac.uk
curl
$ curl 'https://explore.api.aai.ebi.ac.uk/users' -i \
    -H 'Authorization: Bearer eyJhb...h7HgQ' \
    -H 'Accept: application/hal+json'
httpie
$ http GET 'https://explore.api.aai.ebi.ac.uk/users' \
    'Authorization:Bearer eyJhb...h7HgQ' \
    'Accept:application/hal+json'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=utf-8
Content-Length: 1573

[ {
  "userName" : "admin",
  "email" : "admin@example.com",
  "userReference" : "usr-3a34fc8d-6fb5-4601-803e-5f84791150f3",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-3a34fc8d-6fb5-4601-803e-5f84791150f3"
  } ]
}, {
  "userName" : "ajay",
  "email" : "ajay@example.com",
  "userReference" : "usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-e8c1d6d5-6bf4-4636-a70e-41b8f32c70b4"
  } ]
}, {
  "userName" : "karo",
  "email" : "karo@example.com",
  "userReference" : "usr-b070585b-a340-4a98-aff1-f3de48da8c38",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-b070585b-a340-4a98-aff1-f3de48da8c38"
  } ]
}, {
  "userName" : "test1",
  "email" : "test1@test.com",
  "userReference" : "usr-020836e8-2553-4f74-acb6-1f56605829ea",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-020836e8-2553-4f74-acb6-1f56605829ea"
  } ]
}, {
  "userName" : "test2",
  "email" : "test2@test.com",
  "userReference" : "usr-12e7287c-c2de-42e4-a1f7-c62992effa0c",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-12e7287c-c2de-42e4-a1f7-c62992effa0c"
  } ]
}, {
  "userName" : "test3",
  "email" : "test3@test.com",
  "userReference" : "usr-98ff3259-cc2e-45d4-87e0-aee951f8bc25",
  "links" : [ {
    "rel" : "self",
    "href" : "https://explore.api.aai.ebi.ac.uk/users/usr-98ff3259-cc2e-45d4-87e0-aee951f8bc25"
  } ]
} ]