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.
Projects
Activates a User on an Environment.
ActivateUser activates a user on an environment. This will create a new activation record for the user on the environment. Connections must be made for all environment systems to be successfully activated.
POST
/
o
/
{organisation_id}
/
activations
curl --request POST \
--url https://platform.versori.com/api/v2/o/{organisation_id}/activations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"userId": "<string>",
"environmentId": "<string>",
"connections": [
{
"connectionTemplateId": "<string>",
"connection": {
"name": "<string>",
"credentials": [
{
"id": "<string>",
"authSchemeConfig": {
"type": "none",
"none": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"apiKey": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"name": "<string>",
"in": "query"
},
"basicAuth": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"oauth2": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"authorizeUrl": "<string>",
"tokenUrl": "<string>",
"scopes": [
{
"name": "<string>",
"description": "<string>"
}
],
"defaultScopes": [
"<string>"
],
"additionalAuthorizeParams": "<string>",
"additionalTokenParams": "<string>",
"mtlsEnabled": true,
"mtlsCredentialId": "<string>",
"pkce": true,
"grant": {
"authorizationCode": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"clientCredentials": {},
"password": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"type": "authorizationCode"
}
},
"oauth1": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"consumerKey": "<string>",
"consumerSecret": "<string>",
"tempCredentialEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"resourceOwnerAuthorizationEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"tokenEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"signatureMethod": "<string>",
"credentialId": "<string>"
},
"hmac": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"name": "<string>",
"in": "query",
"algorithm": "sha1",
"digestInputs": [
"body"
]
},
"certificate": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"errors": [
"<string>"
],
"data": {
"binary": {
"valueBase64": "<string>"
},
"none": {},
"string": {
"value": "<string>"
},
"basicAuth": {
"username": "<string>",
"password": "<string>"
},
"oauth2Client": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"scopes": [
"<string>"
],
"additionalParams": "<string>",
"mTLSEnabled": true,
"mTLSCredentialId": "<string>"
},
"oauth2Token": {
"scopes": [
"<string>"
],
"accessToken": "<string>",
"tokenType": "Bearer",
"expiresAt": "2023-11-07T05:31:56Z",
"refreshToken": "<string>"
},
"oauth2Code": {
"code": "<string>",
"state": "<string>"
},
"oauth2Password": {
"username": "<string>",
"password": "<string>"
},
"certificate": {
"certificate": "<string>",
"key": "<string>",
"ca": "<string>"
},
"oauth1": {
"state": "<string>",
"oauthToken": "<string>",
"oauthVerifier": "<string>"
}
},
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"baseUrl": "<string>"
},
"existingConnectionId": "<string>"
}
],
"dynamicVariables": {}
}'{
"id": "<string>",
"user": {
"id": "<string>",
"externalId": "<string>",
"displayName": "<string>",
"organisationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"environment": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"publicUrl": "<string>",
"files": [
{
"filename": "<string>",
"content": "<string>"
}
],
"labels": {}
},
"connections": [
{
"id": "<string>",
"name": "<string>",
"credentials": [
{
"id": "<string>",
"authSchemeConfig": {
"type": "none",
"none": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"apiKey": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"name": "<string>",
"in": "query"
},
"basicAuth": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"oauth2": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"authorizeUrl": "<string>",
"tokenUrl": "<string>",
"scopes": [
{
"name": "<string>",
"description": "<string>"
}
],
"defaultScopes": [
"<string>"
],
"additionalAuthorizeParams": "<string>",
"additionalTokenParams": "<string>",
"mtlsEnabled": true,
"mtlsCredentialId": "<string>",
"pkce": true,
"grant": {
"authorizationCode": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"clientCredentials": {},
"password": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"type": "authorizationCode"
}
},
"oauth1": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"consumerKey": "<string>",
"consumerSecret": "<string>",
"tempCredentialEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"resourceOwnerAuthorizationEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"tokenEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"signatureMethod": "<string>",
"credentialId": "<string>"
},
"hmac": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"name": "<string>",
"in": "query",
"algorithm": "sha1",
"digestInputs": [
"body"
]
},
"certificate": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"errors": [
"<string>"
],
"data": {
"binary": {
"valueBase64": "<string>"
},
"none": {},
"string": {
"value": "<string>"
},
"basicAuth": {
"username": "<string>",
"password": "<string>"
},
"oauth2Client": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"scopes": [
"<string>"
],
"additionalParams": "<string>",
"mTLSEnabled": true,
"mTLSCredentialId": "<string>"
},
"oauth2Token": {
"scopes": [
"<string>"
],
"accessToken": "<string>",
"tokenType": "Bearer",
"expiresAt": "2023-11-07T05:31:56Z",
"refreshToken": "<string>"
},
"oauth2Code": {
"code": "<string>",
"state": "<string>"
},
"oauth2Password": {
"username": "<string>",
"password": "<string>"
},
"certificate": {
"certificate": "<string>",
"key": "<string>",
"ca": "<string>"
},
"oauth1": {
"state": "<string>",
"oauthToken": "<string>",
"oauthVerifier": "<string>"
}
},
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"baseUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"systemId": "<string>",
"connectionTemplateId": "<string>"
}
],
"dynamicVariables": {}
}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
Body
application/json
ActivationCreate is the request payload to activate an environment for End User
Response
200 - application/json
OK
The response is of type object.
curl --request POST \
--url https://platform.versori.com/api/v2/o/{organisation_id}/activations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"userId": "<string>",
"environmentId": "<string>",
"connections": [
{
"connectionTemplateId": "<string>",
"connection": {
"name": "<string>",
"credentials": [
{
"id": "<string>",
"authSchemeConfig": {
"type": "none",
"none": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"apiKey": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"name": "<string>",
"in": "query"
},
"basicAuth": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"oauth2": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"authorizeUrl": "<string>",
"tokenUrl": "<string>",
"scopes": [
{
"name": "<string>",
"description": "<string>"
}
],
"defaultScopes": [
"<string>"
],
"additionalAuthorizeParams": "<string>",
"additionalTokenParams": "<string>",
"mtlsEnabled": true,
"mtlsCredentialId": "<string>",
"pkce": true,
"grant": {
"authorizationCode": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"clientCredentials": {},
"password": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"type": "authorizationCode"
}
},
"oauth1": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"consumerKey": "<string>",
"consumerSecret": "<string>",
"tempCredentialEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"resourceOwnerAuthorizationEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"tokenEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"signatureMethod": "<string>",
"credentialId": "<string>"
},
"hmac": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"name": "<string>",
"in": "query",
"algorithm": "sha1",
"digestInputs": [
"body"
]
},
"certificate": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"errors": [
"<string>"
],
"data": {
"binary": {
"valueBase64": "<string>"
},
"none": {},
"string": {
"value": "<string>"
},
"basicAuth": {
"username": "<string>",
"password": "<string>"
},
"oauth2Client": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"scopes": [
"<string>"
],
"additionalParams": "<string>",
"mTLSEnabled": true,
"mTLSCredentialId": "<string>"
},
"oauth2Token": {
"scopes": [
"<string>"
],
"accessToken": "<string>",
"tokenType": "Bearer",
"expiresAt": "2023-11-07T05:31:56Z",
"refreshToken": "<string>"
},
"oauth2Code": {
"code": "<string>",
"state": "<string>"
},
"oauth2Password": {
"username": "<string>",
"password": "<string>"
},
"certificate": {
"certificate": "<string>",
"key": "<string>",
"ca": "<string>"
},
"oauth1": {
"state": "<string>",
"oauthToken": "<string>",
"oauthVerifier": "<string>"
}
},
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"baseUrl": "<string>"
},
"existingConnectionId": "<string>"
}
],
"dynamicVariables": {}
}'{
"id": "<string>",
"user": {
"id": "<string>",
"externalId": "<string>",
"displayName": "<string>",
"organisationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"environment": {
"id": "<string>",
"name": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"publicUrl": "<string>",
"files": [
{
"filename": "<string>",
"content": "<string>"
}
],
"labels": {}
},
"connections": [
{
"id": "<string>",
"name": "<string>",
"credentials": [
{
"id": "<string>",
"authSchemeConfig": {
"type": "none",
"none": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"apiKey": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"name": "<string>",
"in": "query"
},
"basicAuth": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
},
"oauth2": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"authorizeUrl": "<string>",
"tokenUrl": "<string>",
"scopes": [
{
"name": "<string>",
"description": "<string>"
}
],
"defaultScopes": [
"<string>"
],
"additionalAuthorizeParams": "<string>",
"additionalTokenParams": "<string>",
"mtlsEnabled": true,
"mtlsCredentialId": "<string>",
"pkce": true,
"grant": {
"authorizationCode": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"clientCredentials": {},
"password": {
"credentialId": "<string>",
"organisationId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"type": "authorizationCode"
}
},
"oauth1": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"consumerKey": "<string>",
"consumerSecret": "<string>",
"tempCredentialEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"resourceOwnerAuthorizationEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"tokenEndpoint": {
"url": "<string>",
"additionalParamConfigs": [
{
"parameterName": "<string>",
"targetName": "<string>",
"location": "LOCATION_IGNORE",
"usages": "USAGE_UNKNOWN",
"required": true,
"modifiable": true
}
],
"parameterTransmission": "AUTH_STYLE_AUTHORIZATION_HEADER"
},
"signatureMethod": "<string>",
"credentialId": "<string>"
},
"hmac": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
],
"name": "<string>",
"in": "query",
"algorithm": "sha1",
"digestInputs": [
"body"
]
},
"certificate": {
"id": "<string>",
"description": "<string>",
"validationMessages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"type": "none",
"name": "<string>",
"errors": [
"<string>"
],
"data": {
"binary": {
"valueBase64": "<string>"
},
"none": {},
"string": {
"value": "<string>"
},
"basicAuth": {
"username": "<string>",
"password": "<string>"
},
"oauth2Client": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"scopes": [
"<string>"
],
"additionalParams": "<string>",
"mTLSEnabled": true,
"mTLSCredentialId": "<string>"
},
"oauth2Token": {
"scopes": [
"<string>"
],
"accessToken": "<string>",
"tokenType": "Bearer",
"expiresAt": "2023-11-07T05:31:56Z",
"refreshToken": "<string>"
},
"oauth2Code": {
"code": "<string>",
"state": "<string>"
},
"oauth2Password": {
"username": "<string>",
"password": "<string>"
},
"certificate": {
"certificate": "<string>",
"key": "<string>",
"ca": "<string>"
},
"oauth1": {
"state": "<string>",
"oauthToken": "<string>",
"oauthVerifier": "<string>"
}
},
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"baseUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"systemId": "<string>",
"connectionTemplateId": "<string>"
}
],
"dynamicVariables": {}
}Assistant
Responses are generated using AI and may contain mistakes.