Skip to content
Home/
/
/
Retrieve a portal user

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

Retrieve portal users

Request

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

Security
JWT
Query
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
emailstring

Filter by an admin portal user's email address. This query is not case sensitive.

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/portal-users?page=0&pageSize=50&email=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

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

The total number of records that exist for the request.

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

Add a portal user

Request

Add an admin portal user to a specified workspace. The user is assigned a super admin role.

Security
JWT
Headers
Workspacestringrequired

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

Example: corodevonmicrosoftcom_TX7T_u
Bodyapplication/jsonrequired
firstNamestringrequired

The admin portal user's first name.

Example: "Martin"
lastNamestringrequired

The admin portal user's last name.

Example: "Simpson"
emailstringrequired

The admin portal user's email address.

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

Responses

Success

Bodyapplication/json
idstring

The unique identifier for the admin portal user.

Example: "1028361sy8163gqa"
userStatusstring

The status of the add admin portal user response.

Example: "Unable to add user"
Response
application/json
{
  "id": "1028361sy8163gqa",
  "userStatus": "Unable to add user"
}

Retrieve a portal user

Request

Retrieve an admin portal 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/portal-users/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Bodyapplication/json
portalUserobject(PortalUsersResponse)

Portal user response.

userStatusstring

The status of the get portal user response.

Example: "OK"
Response
application/json
{
  "portalUser": {
    "id": "1028361sy8163gqa",
    "firstName": "Martin",
    "lastName": "Simpson",
    "email": "coro@corotest.com",
    "status": {},
    "inviteSentOn": 0,
    "mfaConfig": "NONE",
    "role": { … },
    "monitoredScopes": { … },
    "emailProxyMonitoredScopes": { … }
  },
  "userStatus": "OK"
}

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

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