Skip to content
Home/
/
/
Add protected users

Coro Cybersecurity Public API (v1)


This is the Coro Cybersecurity platform API specification reference.

This section provides a complete reference listing for the Coro Cybersecurity REST API resource model.

About the resource reference

This reference lists all the resources available through the Coro REST API.

Each section relates to a specific resource and provides its name, description, unique URI path, and the list of operations you can perform on it.

For each operation, you can find:

  • A complete description of the action
  • Request parameters
  • A list of potential responses
  • Security (authentication) requirements

The portal also provides code samples and examples for making requests in a number of programming languages, together with samples of the possible response bodies.

In addition to this, Coro provides a Try It feature where you can interact with the API directly through the portal. To use Try It, you'll need to first obtain Client ID and Secret credentials; for more information, see Authentication.

Download OpenAPI description
View and download the Coro API JSON specification
Overview
URL
https://support.coro.net
E-mail
support@coro.net
Terms of Service
Languages
Servers
Coro mock API server
https://docs.coro.net/_mock/api/api-docs
Coro US API server target URL
https://api.secure.coro.net

audit-logs

This is the audit log resource.

Operations

authentication

This is the resource for API authentication requests.

Use this resource to validate your identify and to obtain a bearer token to use when accessing other API resources.

Operations

devices

This is the Devices resource.

Use this resource to get details of all protected devices for a particular workspace.

Operations

portal-users

This is the portal user resource.

Use this resource to get details of all portal users added to the specified workspace.

Operations

subscriptions

This is the subscriptions resource.

Use this resource to view and manage workspace subscriptions.

Operations

tickets

This is the Tickets resource.

Use this resource to get details of all tickets stored in the Coro platform for a particular workspace.

Operations

tickets-summary

This is the Tickets Summary resource.

Use this resource to get details of tickets for a particular workspace, grouped by protection component.

Operations

usage

This is the resource for Coro usage.

Use this resource to obtain information about usage

Operations

users

This is the protected user resource.

Use this resource to get details of all protected users added to the specified workspace.

Operations

Retrieve users

Request

Retrieve a list of users in a workspace. This call supports pagination; default page size includes 20 users.

Security
JWT
Query
emailstring

Filter by a user’s email address. This is not case sensitive.

namestring

Filter by a user’s name. This is not case sensitive.

pagestring>= 0

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

Default "0"
Example: page=0
pageSizestring[ 10 .. 500 ]

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

Default "20"
Example: pageSize=50
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X GET \
  'https://docs.coro.net/_mock/api/api-docs/v1/users?email=string&name=string&page=0&pageSize=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Bodyapplication/json
itemsArray of objects(EndUserResponse)
totalElementsinteger(int64)

The total number of records that exist for the request.

Response
application/json
{
  "items": [
    { … }
  ],
  "totalElements": 0
}

Update user

Request

Update the details of a user.

Security
JWT
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
Bodyapplication/jsonrequired
emailstringrequired

The user's email address.

Example: "corotest@corotest.com"
protectedUserbooleanrequired

The protection status of the user.

Example: true
curl -i -X PUT \
  https://docs.coro.net/_mock/api/api-docs/v1/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u' \
  -d '{
    "email": "corotest@corotest.com",
    "protectedUser": true
  }'

Responses

Success

Bodyapplication/json
idstring

The unique identifier of the user.

Example: "62ff9653efef4b3ae04ab25e"
emailstring

The user’s email address.

Example: "test@test.com"
namestring

The user’s full name.

Example: "Harry Owen"
protectedUserboolean

The protection status of the user.

Response
application/json
{
  "id": "62ff9653efef4b3ae04ab25e",
  "email": "test@test.com",
  "name": "Harry Owen",
  "protectedUser": true
}

Add protected users

Request

Add protected users to a workspace.

Security
JWT
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
Bodyapplication/jsonrequired
usersArray of objects(UserRequest)[ 1 .. 200 ] itemsuniquerequired

The list of protected users to add. Up to 200 users can be added to a workspace.

users[].​emailstringrequired

The user’s email address.

Example: "test@test.com"
users[].​namestring

The user's full name.

Example: "Harry Owen"
curl -i -X POST \
  https://docs.coro.net/_mock/api/api-docs/v1/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u' \
  -d '{
    "users": [
      {
        "email": "test@test.com",
        "name": "Harry Owen"
      }
    ]
  }'

Responses

Success

Bodyapplication/json
usersArray of objects(EndUserResponse)

The list of users that were added to protection

Response
application/json
{
  "users": [
    { … }
  ]
}

Retrieve a user

Request

Retrieve a user by their unique identifier.

Security
JWT
Path
idstringrequired
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X GET \
  'https://docs.coro.net/_mock/api/api-docs/v1/users/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Bodyapplication/json
idstring

The unique identifier of the user.

Example: "62ff9653efef4b3ae04ab25e"
emailstring

The user’s email address.

Example: "test@test.com"
namestring

The user’s full name.

Example: "Harry Owen"
protectedUserboolean

The protection status of the user.

Response
application/json
{
  "id": "62ff9653efef4b3ae04ab25e",
  "email": "test@test.com",
  "name": "Harry Owen",
  "protectedUser": true
}

Delete a user

Request

Delete a user by their unique identifier. This action cannot be undone.

Security
JWT
Path
idstringrequired
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X DELETE \
  'https://docs.coro.net/_mock/api/api-docs/v1/users/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Bodyapplication/json
Response
application/json
null

webhook-configuration

Use this resource to manage or view details of existing webhooks configurations, or to create new webhook configurations.

Operations

workspaces

Use this resource to view details of provisioned workspaces, or to create new workspaces.

Operations