Contributors

Usage service handles licensing

Retrieve the list of active versions

This API endpoint retrieves the list of active versions.

Securityx-api-key
Request
query Parameters
page_size
integer

The number of records to return per page. Default is not specified.

page
integer

The page number to retrieve. Default is 0 (the first page).

Responses
200

OK response.

get/v1/org/users/versions
Request samples
curl 'https://app.harness.io/gratis/sei/api/v1/org/users/versions?page_size=999' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'authorization: Bearer <your_access_token>'
Response samples
application/json
{
  • "records": [
    ],
  • "count": 521,
  • "_metadata": {
    }
}

Retrieve the schema used by current contributor pages and custom fields

This API endpoint retrieves the schema used by the current contributor pages, including any custom fields.

Securityx-api-key
Responses
200

OK response.

get/v1/org/users/schema
Request samples
curl 'https://app.harness.io/gratis/sei/api/v1/org/users/schema' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'authorization: Bearer <your_access_token>'
Response samples
application/json
{
  • "version": 190,
  • "created_at": 1710153327501,
  • "fields": [
    ]
}

Retrieve the list of current active users

This API endpoint retrieves the list of current active users.

Securityx-api-key
Request
query Parameters
version
integer

The version of the schema to use for the list of contributors.

Request Body schema: application/json
required
page
integer
Default: 0

The page number to retrieve.

page_size
integer
Default: 50

The number of records to return per page.

filter
object

Filter criteria for the list of contributors.

Responses
200

OK response.

post/v1/org/users/list
Request samples
application/json
{
  • "page": 0,
  • "page_size": 50,
  • "filter": { }
}
Response samples
application/json
{
  • "records": [
    ],
  • "_metadata": {
    }
}

Update existing contributors

This API endpoint is used to update existing contributors (users) in the system.

Securityx-api-key
Request
Request Body schema: application/json
required
Array
id
string

The unique identifier of the contributor.

org_uuid
string

The UUID of the Collection the contributor belongs to.

full_name
string

The updated full name of the contributor.

email
string

The updated email address of the contributor.

integration_user_ids
Array of objects

An array of objects representing the integration user IDs associated with the contributor.

additional_fields
object

An object containing additional fields for the contributor (based on the schema).

version
string

The version of the contributor record.

created_at
integer

The timestamp when the contributor record was created (in milliseconds).

updated_at
integer

The timestamp when the contributor record was last updated (in milliseconds).

dynamic_column_aggs_region
string

A dynamic field for region aggregation.

Responses
200

Update successful.

400

Bad request. Indicates an issue with the request payload.

404

Not found. Indicates the contributor with the specified ID was not found.

put/v1/org/users
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "message": "Contributor with ID 3 updated successfully."
}

Retrieve SEI contributors list

This API endpoint retrieves the list of licensed users for the given organization.

Securityx-api-key
Request
Request Body schema: application/json
required
object
Responses
200

OK response.

post/v1/sei_contributor/list
Request samples
application/json
{ }
Response samples
application/json
{
  • "org_user_count": 27,
  • "integration_user_count": 86,
  • "org_user_details": [
    ]
}