Skip to content

Latest commit

 

History

History
151 lines (120 loc) · 4.4 KB

Users.md

File metadata and controls

151 lines (120 loc) · 4.4 KB
Raw

Cloud Conformity API Keys API

Below is a list of the available APIs:

User Privileges

There are 4 possible Cloud Conformity roles. Each role grants different levels of access via the api. The roles are:

  • organisation admin
  • organisation user with full access to account
  • organisation user with read-only access to account
  • organisation user with no access to account

User access to each endpoint is listed below:

Endpoint admin full access user read-only user no access user
GET /api-keys (get a list of your api keys) Y Y Y Y
GET /api-keys/id (get details about an api key) Y Y Y Y
POST /accounts (create a new account) Y N N N
GET /accounts (get a list of accounts you have access to) Y Y Y Y
GET /accounts/id Y Y Y N
POST /accounts/id/scan (run the conformity bot) Y Y N N
PATCH /accounts/id/subscription Y N N N
PATCH /accounts/id Y Y N N
GET /accounts/id/settings/rules/ruleId Y Y Y N
PATCH /accounts/id/settings/rules/ruleId Y Y N N
GET /accounts/id/settings/rules Y Y Y N
PATCH /accounts/id/settings/rules Y Y N N
GET /checks * Y Y Y N
POST /checks Y Y N N
DELETE /checks/id Y Y N N
GET /events *** Y Y Y N
GET /settings/communication/accountId ** Y Y Y N
POST /settings/communication ** Y Y N N
PATCH /settings/communication/settingId ** Y Y N N
DELETE /settings/settingId ** Y Y N N
POST /external-ids Y N N N
GET /users/whoami Y Y Y Y
GET /users/id Y Y Y Y
  • Response will depend on the AccountIds added to the query parameter. For example, if a user has no access to an account and they add that account to the AccountIds array, an error will be thrown.

** User role will limit the amount of data they can GET or POST/PATCH. For more information, consult the Settings ReadMe.

*** If user role is ADMIN, organisation-level events will also be returned.

Get The Current User

This endpoint get the current user.

Endpoints:

GET /users/whoami

Parameters

This end point takes no parameters.

Example Request:

curl -H "Content-Type: application/vnd.api+json" \
-H "Authorization: ApiKey S1YnrbQuWagQS0MvbSchNHDO73XHqdAqH52RxEPGAggOYiXTxrwPfmiTNqQkTq3p" \
https://us-west-2-api.cloudconformity.com/v1/users/whoami

Example Response:

{
    "data": {
        "type": "users",
        "id": "517uNyIvG",
        "attributes": {
            "first-name": "Scott",
            "last-name": "Tiger",
            "role": "ADMIN",
            "email": "******@cloudconformity.com",
            "status": "ACTIVE",
            "mfa": false,
            "last-login-date": 1503586843842,
            "created-date": 1485834564224
        },
        "relationships": {
            "organisation": {
                "data": {
                    "type": "organisations",
                    "id": "A9NDYY12z"
                }
            }
        }
    }
}

Get User Details

This endpoint allows you to get the details of the specified user.

Endpoints:

GET /users/id

Parameters
  • id: The Cloud Conformity ID of the user

Example Request:

curl -H "Content-Type: application/vnd.api+json" \
-H "Authorization: ApiKey S1YnrbQuWagQS0MvbSchNHDO73XHqdAqH52RxEPGAggOYiXTxrwPfmiTNqQkTq3p" \
https://us-west-2-api.cloudconformity.com/v1/users/CClqMqknVb

Example Response:

{
    "data": {
        "type": "users",
        "id": "CClqMqknVb",
        "attributes": {
            "first-name": "Cool",
            "last-name": "Claude",
            "role": "ADMIN",
            "email": "[email protected]",
            "status": "ACTIVE",
            "last-login-date": 1523009079960,
            "created-date": 1499359762438,
            "summary-email-opt-out": true,
            "mobile": "15144008080",
            "mobile-country-code": "CA",
            "mobile-verified": true
        },
        "relationships": {
            "organisation": {
                "data": {
                    "type": "organisations",
                    "id": "A9NDYY12z"
                }
            }
        }
    }
}