Access Service API

API Endpoint

Terminology

Utility Endpoints

In addition to the API, the following utility endpoints are available:

  • /health - Health-check page.

  • /health/fault - Purposefully generate a fault page (for diagnostics).

  • Home - Page showing the API name.

Security Groups

Security Groups

POST /security_groups
RequestsCreate security group
Headers
Content-Type: application/vnd.api+json
Authorization: [MyAuthToken][]
Body
{
  "data": {
    "type": "security_groups",
    "attributes": {
      "label": "string",
      "ranges": [
        {
          "label": "string",
          "cidr": "0.0.0.0/32"
        },
        {
          "label": "string",
          "cidr": "0.0.0.0/32"
        }
      ]
    }
  }
}
Responses200400401403500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Create a Security Group
POST/security_groups

Create a security group.

Requires permission ACCESS:FUNCTIONAL:SECURITYGROUP:CREATE

Security Groups

PUT /security_groups
RequestsUpdate security group
Headers
Content-Type: application/vnd.api+json
Authorization: [MyAuthToken][]
Body
{
  "data": {
    "type": "security_groups",
    "id": "00000000-0000-0000-0000-000000000000",
    "attributes": {
      "label": "string",
      "ranges": [
        {
          "label": "string",
          "cidr": "0.0.0.0/32"
        },
        {
          "label": "string",
          "cidr": "0.0.0.0/32"
        }
      ]
    }
  }
}
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Update a Security Group
PUT/security_groups

Update a security group.

Requires permission ACCESS:FUNCTIONAL:SECURITYGROUP:EDIT

Security Groups

GET /security_groups/uuid
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Get a Security Group
GET/security_groups/{id}

Get a security group by id.

Requires permission ACCESS:FUNCTIONAL:SECURITYGROUP:READ

URI Parameters
HideShow
id
string (required) Example: uuid

security group id

Security Groups

GET /security_groups
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Get all Security Groups
GET/security_groups

Get all security groups.

Requires permission ACCESS:FUNCTIONAL:SECURITYGROUP:READ

Security Groups

DELETE /security_groups/uuid
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Get a Security Group
DELETE/security_groups/{id}

Delete a security group by id.

Requires permission ACCESS:FUNCTIONAL:SECURITYGROUP:DELETE

URI Parameters
HideShow
id
string (required) Example: uuid

security group id

Security Group Relationships

Security Groups Relationships

GET /security_groups/uuid/services/uuid
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Get a Security Group Relationship
GET/security_groups/{group}/services/{service}

Get a security group relationship.

Requires permission ACCESS:FUNCTIONAL:SECURITYGROUPRELATIONSHIP:READ

URI Parameters
HideShow
group
string (required) Example: uuid

security group id

service
string (required) Example: uuid

service id

Security Groups Relationships

GET /security_groups/uuid/services
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
+ Body
                 {
                   "status": 400,
                   "errorMessage": "Fault"
                 }
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Get Security Group Relationships
GET/security_groups/{group}/services

Get all relationships for a Security Group.

Requires permission ACCESS:FUNCTIONAL:SECURITYGROUPRELATIONSHIP:READ

URI Parameters
HideShow
group
string (required) Example: uuid

security group id

Security Groups Relationships

POST /security_groups/uuid/services/uuid
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Create a Security Group Relationship
POST/security_groups/{group}/services/{service}

Create a security group relationship.

Requires permission ACCESS:FUNCTIONAL:SECURITYGROUPRELATIONSHIP:CREATE

URI Parameters
HideShow
group
string (required) Example: uuid

security group id

service
string (required) Example: uuid

service id

Security Groups Relationships

DELETE /security_groups/uuid/services/uuid
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Delete a Security Group Relationship
DELETE/security_groups/{group}/services/{service}

Delete a security group relationship.

Requires permission ACCESS:FUNCTIONAL:SECURITYGROUPRELATIONSHIP:DELETE

URI Parameters
HideShow
group
string (required) Example: uuid

security group id

service
string (required) Example: uuid

service id

Generated on 17 Nov 2016