orgservice

Org Service

GET /api/org/id/:id

• Gets an org
• Response: Status 200

{
  "orgid": "<org id>",
  "name": "<name>",
  "display_name": "<display name>",
  "desc": "<description>",
  "creation_time": "<creation time>",
}

GET /api/org/name/:name

• Gets an org
• Response: Status 200

{
  "orgid": "<org id>",
  "name": "<name>",
  "display_name": "<display name>",
  "desc": "<description>",
  "creation_time": "<creation time>",
}

GET /api/org/ids?ids=<comma delimited ids>

• Gets orgs by ids
• Response: Status 200

{
  "orgs": [
    {
      "orgid": "<org id>",
      "name": "<name>",
      "display_name": "<display name>",
      "desc": "<description>",
      "creation_time": "<creation time>",
    },
  ],
}

GET /api/org?limit=<limit>&offset=<offset>

• Gets orgs ordered by creation time descending
• Response: Status 200

{
  "orgs": [
    {
      "orgid": "<org id>",
      "name": "<name>",
      "display_name": "<display name>",
      "desc": "<description>",
      "creation_time": "<creation time>",
    },
  ],
}

POST /api/org

• Creates a new org
• Header: Authorization: Bearer <access token>
• Scope: gov.user.org:write
• Request:

{
  "display_name": "<display name>",
  "desc": "<description>",
}

• Response: Status 201

{
  "orgid": "<org id>",
  "name": "<name>",
  "display_name": "<display name>",
  "desc": "<description>",
  "creation_time": "<creation time>",
}

PUT /api/org/id/:id

• Updates an org
• Header: Authorization: Bearer <access token>
  • Only accessible by org mod
• Scope: gov.user.org:write
• Request:

{
  "name": "<name>",
  "display_name": "<display name>",
  "desc": "<description>",
}

• Response: Status 204

DELETE /api/org/id/:id

• Deletes an org
• Header: Authorization: Bearer <access token>
  • Only accessible by org mod
• Scope: gov.user.org:write
• Response: Status 204