GET /organizations/{name}

This operation retrieves the data for an organization within CAVE. The response contains the whole organization, in JSON format.

The operation can be executed only by users that are administrators or members of the organization.

Resource URL

https://api.cavellc.io/organizations/{name}

Resource Information

The request must be authenticated with a valid user token, as obtained from a login operation. See POST /users/login for details. The token can be passed as the username (with an empty password) following the Basic Authentication scheme of the HTTP protocol. Alternatively, the same token can be accepted as a Bearer Token, similar to the OAuth2 specification.

Example Request

curl -i -u 8b896055-c295-4a30-a29c-5a97d15f1818: https://api.cavellc.io/organizations/acme

Example Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Location: https://api.cavellc.io/organizations/acme
Content-Length: 246
Connection: keep-alive

{
  "name": "acme",
  "email": "cave@acme.inc",
  "notification_url": "https://api.acme.inc/notifications",
  "tokens": [
    {
      "id: "76",
      "description": "default",
      "value": "REKEfGtNqdITKDB0z2Ok7YcmouB5DtaSJhlK9TmruOA3jgW4YcSxsTGq",
      "created": "2014-10-23T14:51:06.101Z"
    }
  ]
}

See Also

Back to Organizations

Back to API Main Page