Activations
Connections
Projects
- POSTActivates a User on an Environment.
- POSTCreate new project
- DELDelete Project
- PUTDeploy Project
- GETGet Files
- GETGet Project Logs
- GETGet Project
- GETGet Trace
- GETList project traces
- GETList projects for organisation
- PATCHPatch the schema for the project's dynamic variables
- PUTSet the schema for the project variables
- POSTSuspend Project
- PUTUpdate Files
- PUTUpdate Project
Systems
- POSTAdd a system to a project environment
- PUTAdds or updates an auth scheme for the system.
- POSTCreate a new connection template
- POSTCreate a new system.
- DELDeletes an auth scheme for the system.
- GETList project environment connection templates
- GETList the systems linked to the project environment.
- GETLists the systems for the organisation.
- DELRemove a connection template
- PUTRemove a system from a project environment
- DELRemove a system from a project environment
- PUTUpdate system.
curl --request GET \
--url https://platform.versori.com/api/v2/o/{organisation_id}/users \
--header 'Authorization: Bearer <token>'{
"totalCount": 123,
"users": [
{
"id": "<string>",
"externalId": "<string>",
"displayName": "<string>",
"organisationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"next": "<string>",
"prev": "<string>"
}List End Users
ListEndUsers returns a list of all the End Users for the given organisation.
curl --request GET \
--url https://platform.versori.com/api/v2/o/{organisation_id}/users \
--header 'Authorization: Bearer <token>'{
"totalCount": 123,
"users": [
{
"id": "<string>",
"externalId": "<string>",
"displayName": "<string>",
"organisationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"next": "<string>",
"prev": "<string>"
}Authorizations
Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.
Path Parameters
Query Parameters
Search is a string that is used to filter the list of End Users. The search string is matched against the id, externalId and displayName fields.
Filter users by their activation status. Must be used together with environment_id. If not provided, returns all users regardless of activation status.
Filter users by activations in a specific environment. Must be used together with the 'activated' parameter. When combined with 'activated=true', it returns users that are activated in the specified environment. When combined with 'activated=false', it returns users that are not activated in this specific environment. If not provided, returns users from all environments.
Response
OK
Show child attributes
Show child attributes
ID is the Versori identifier for the user. Most APIs will not use this field but instead reference users by their externalId.
ExternalID is the identifier for the user as determined by the organisation. This typically should be the same as the user's ID on the organisations system. Regardless of the value, it must be unique within the Organisation.
DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.
The organisation ID to which the user belongs to.
CreatedAt is the time the user was created.
UpdatedAt is the time the user was last updated.