Public API (v1)
Download OpenAPI specification:Download
Onboard user by accepting community terms and cond
Onboard user by accepting community terms and conditions.
Request Body schema: application/json
family_name required | string |
given_name required | string |
Responses
Request samples
- Payload
{- "family_name": "string",
- "given_name": "string"
}
Onboard user by accepting compute terms and condit
Onboard user by accepting compute terms and conditions.
Request Body schema: application/json
family_name required | string |
given_name required | string |
Responses
Request samples
- Payload
{- "family_name": "string",
- "given_name": "string"
}
Update a community learner for the user.
Update a community learner for the user.
path Parameters
package required | string |
Request Body schema: application/json
required | object | ||
|
Responses
Request samples
- Payload
{- "progress": {
- "property1": "DONE",
- "property2": "DONE"
}
}
Create new project.
Create new project.
Request Body schema: application/json
account_manager_id required | string ID of the account manager |
Array of objects (ConsumedAdditionalAccessGrant) | |
admin_email required | string <email> Email of the first admin to add to the project. |
allowed_device_types | Array of strings Items Enum: "EMU_FREE" "EMU_SV" "EMU_TN" "EMU_C" "FRESNEL" "EMU_FRESNEL" A list of DeviceType the project can use |
company required | string |
description | string or null |
email_domain | string or null |
name required | string |
package required | string Enum: "QUANTUM_DISCOVERY" "QUANTUM_DISCOVERY_CHEMISTRY" "QUANTUM_DISCOVERY_LIGHT" "QUANTUM_DISCOVERY_PLAY" "QUANTUM_DISCOVERY_ESSENTIAL" "LEARN_BY_CODING" "VQPU" Package of the project. |
project_type | string Enum: "INTERNAL" "CLIENT" "ACADEMIC" the type of project account managers or support members are working on |
queue_priority | string Enum: "LOW" "MEDIUM" "HIGH" A value representing the priority the associated batches are scheduled |
Responses
Request samples
- Payload
{- "account_manager_id": "string",
- "additional_access_grants": [
- {
- "grant": "usecase:submit",
- "role": "ADMIN"
}
], - "admin_email": "user@example.com",
- "allowed_device_types": [
- "EMU_FREE"
], - "company": "string",
- "description": "string",
- "email_domain": "string",
- "name": "string",
- "package": "QUANTUM_DISCOVERY",
- "project_type": "INTERNAL",
- "queue_priority": "LOW"
}
Update a project.
Update a project.
path Parameters
project_id required | string |
Request Body schema: application/json
company | string |
description | string or null |
name | string |
package | string Enum: "QUANTUM_DISCOVERY" "QUANTUM_DISCOVERY_CHEMISTRY" "QUANTUM_DISCOVERY_LIGHT" "QUANTUM_DISCOVERY_PLAY" "QUANTUM_DISCOVERY_ESSENTIAL" "LEARN_BY_CODING" "VQPU" Package of the project. |
Responses
Request samples
- Payload
{- "company": "string",
- "description": "string",
- "name": "string",
- "package": "QUANTUM_DISCOVERY"
}
Check whether a user has the right access_grants t
Check whether a user has the right access_grants to execute an operation on a project
path Parameters
project_id required | string |
query Parameters
authorizations required | Array of strings Items Enum: "usecase:submit" "test:1" "test:2" "test:3" |
subject_id required | string |
Responses
Update additional access grants on a given project
Update additional access grants on a given project. Requires superuser credentials.
path Parameters
project_id required | string |
Request Body schema: application/json
Array of objects (ConsumedAdditionalAccessGrant) | |||||
Array
|
Responses
Request samples
- Payload
{- "additional_access_grants": [
- {
- "grant": "usecase:submit",
- "role": "ADMIN"
}
]
}
Update project as manager.
Update project as manager.
path Parameters
project_id required | string |
Request Body schema: application/json
account_manager_id | string ID of the account manager |
Array of objects (ConsumedAdditionalAccessGrant) | |
allowed_device_types | Array of strings Items Enum: "EMU_FREE" "EMU_SV" "EMU_TN" "EMU_C" "FRESNEL" "EMU_FRESNEL" A list of DeviceType the project can use |
company | string |
description | string or null |
name | string |
package | string Enum: "QUANTUM_DISCOVERY" "QUANTUM_DISCOVERY_CHEMISTRY" "QUANTUM_DISCOVERY_LIGHT" "QUANTUM_DISCOVERY_PLAY" "QUANTUM_DISCOVERY_ESSENTIAL" "LEARN_BY_CODING" "VQPU" Package of the project. |
project_type | string Enum: "INTERNAL" "CLIENT" "ACADEMIC" the type of project account managers or support members are working on |
queue_priority | string Enum: "LOW" "MEDIUM" "HIGH" A value representing the priority the associated batches are scheduled |
Responses
Request samples
- Payload
{- "account_manager_id": "string",
- "additional_access_grants": [
- {
- "grant": "usecase:submit",
- "role": "ADMIN"
}
], - "allowed_device_types": [
- "EMU_FREE"
], - "company": "string",
- "description": "string",
- "name": "string",
- "package": "QUANTUM_DISCOVERY",
- "project_type": "INTERNAL",
- "queue_priority": "LOW"
}
Add or update members for a project. When an email
Add or update members for a project. When an email address is not found invite it.
path Parameters
project_id required | string |
Request Body schema: application/json
emails required | Array of strings <email> [ items <email > ] |
role | string Enum: "ADMIN" "MEMBER" Role of the member. |
Responses
Request samples
- Payload
{- "emails": [
- "user@example.com"
], - "role": "ADMIN"
}
Update existing members for a project.
Update existing members for a project.
path Parameters
project_id required | string |
Request Body schema: application/json
role | string Enum: "ADMIN" "MEMBER" Role of the member. |
user_ids required | Array of strings |
Responses
Request samples
- Payload
{- "role": "ADMIN",
- "user_ids": [
- "string"
]
}
Add or update members for a project. When an email
Add or update members for a project. When an email address is not found invite it.
path Parameters
project_id required | string |
Request Body schema: application/json
emails required | Array of strings <email> [ items <email > ] |
role | string Enum: "ADMIN" "MEMBER" Role of the member. |
Responses
Request samples
- Payload
{- "emails": [
- "user@example.com"
], - "role": "ADMIN"
}
Update existing members for a project.
Update existing members for a project.
path Parameters
project_id required | string |
Request Body schema: application/json
role | string Enum: "ADMIN" "MEMBER" Role of the member. |
user_ids required | Array of strings |
Responses
Request samples
- Payload
{- "role": "ADMIN",
- "user_ids": [
- "string"
]
}