 |
API Documentation
|
|
API Documentation
|
where {orgId} is the ID of an organisation.
POST - adds one or more new user whitelist rule/s to an organisation (specified by orgId).GET - retrieves a list of information for all existing user whitelist rules configured in an organisation (specified by orgId).This API endpoint servers a number of purposes:
orgId). If the email addresses of any Cocoon Data users do not match/comply with any user whitelist rule configured in the organisation, then these users cannot be shared items by other users within the organisation. This also includes anyone else who does not yet have a user account registered on the Cocoon Data Platform but whose email address does not match/comply with an existing user whitelist rule. orgId). The list of user whitelist rules returned in the response can be ordered, sorted and paginated.This API endpoint supports requests utilizing Cocoon Data user accounts with the following roles (as described in the Organisation Administrator's Guide) and conditions:
{orgId} in the request's URL.The Cocoon Data Platform's resources available to a Cocoon Data user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.
The appropriate access token as the Bearer token:
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...The following header is required if the body of the request has a JSON object:
Content-Type: application/jsonThe following required parameters must be sent in the body of the POST request, each as individual members of a JSON object:
{orgId} in the request's URL. The following optional parameters can be sent in the URL of the GET request:
0 to 100, representing the maximum number of items to be returned in the response, where an individual item is information about a user whitelist entry in the organisation (specified by {orgId} in the request's URL). If this parameter is omitted, then its value is 0 by default, which does not apply restrictions to the number of items returned in the response. {orgId} in the URL) returned in the response. Calls to this API endpoint may amount to potentially large numbers of items being returned from the Cocoon Data Platform. Since the order of these items in the response could differ significantly, based on the values of the orderBy and sortBy parameters below, this offset parameter provides pagination for items returned in responses, allowing items to be retrieved from any count greater than 0 (i.e. the first item returned in a response). If this parameter is omitted, then its value is 0 by default. {orgId} in the URL) are returned in the response. This parameter orders items according to the value of the sortBy parameter specified below. Ordering items can be in either ascending alphanumeric order (by specifying the value ASC for this parameter) or descending order (by specifying the value DESC). If this parameter is omitted, then its value is ASC by default. {orgId} in the URL) returned in the response will be sorted. Valid field values for this parameter include: pattern - the domain or email address of the user whitelist rule, description - the description of the user whitelist rule, created - the date and time when the user whitelist rule was created and modified - the date and time when the user whitelist rule was last modified. If the request succeeded, then an HTTP response status 200 OK is returned.
For successful requests only, a JSON-formatted response containing the following members is also returned:
{orgId} in the request's URL), where these rules have been filtered by any parameters submitted in the request. Each element of this array contains information about one of these user whitelist rules (represented as an object containing the following members unless otherwise stated). {orgId} in the URL) that can be returned in the response. 