Portal API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: 1.0.0
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Auth

Backend

Auth

Up
post /auth/oauth/token
(createToken)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AnyType (optional)
Body Parameter

Return type

oas_any_type_not_mapped

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

oas_any_type_not_mapped

Up
get /auth/oauth/authorize
(listAuthorizes)

Return type

array[oas_any_type_not_mapped]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /auth/oauth/.well-known/jwks
(listJWKs)

Return type

array[oas_any_type_not_mapped]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /auth/oauth/.well-known/openid-configuration
(listOpenIDConfigs)

Return type

array[oas_any_type_not_mapped]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Backend

Up
put /backend/projects/{id}/archive/
(archiveProject)
Show, add, and modify projects.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Project Project (optional)
Body Parameter

Return type

Project

Example data

Content-Type: application/json
{
  "resources_support" : true,
  "gid" : 1801372,
  "code" : "code",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "user_has_role" : true,
  "destination" : "destination",
  "resources" : [ {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  }, {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  } ],
  "services_support" : true,
  "legal_approval_group" : 5,
  "legal_support_contact" : "legal_support_contact",
  "expiration_date" : "2000-01-23",
  "users" : [ {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  }, {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  } ],
  "archived" : true,
  "ssh_support" : true,
  "identity_provider" : 9,
  "additional_info" : "additional_info",
  "permissions" : {
    "edit" : {
      "resources_support" : true,
      "code" : true,
      "ip_address_ranges" : true,
      "destination" : true,
      "resources" : true,
      "services_support" : true,
      "legal_support_contact" : true,
      "legal_approval_group" : true,
      "expiration_date" : true,
      "users" : [ "USER", "USER" ],
      "ssh_support" : true,
      "identity_provider" : true,
      "additional_info" : true,
      "name" : true,
      "data_specification_approval_group" : true
    },
    "archive" : true
  },
  "name" : "name",
  "id" : 0,
  "data_specification_approval_group" : 5,
  "data_transfer_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Project

Up
post /backend/data-package/check/
(checkDataPackage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataPackageCheck DataPackageCheck (optional)
Body Parameter

Return type

DataPackageCheck

Example data

Content-Type: application/json
{
  "data_transfer" : "data_transfer",
  "metadata" : "metadata",
  "purpose" : "PRODUCTION",
  "file_name" : "file_name",
  "metadata_hash" : "metadata_hash",
  "project_code" : "project_code"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

DataPackageCheck

Up
post /backend/contact/
(createContact)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Contact Contact (optional)
Body Parameter

Return type

Contact

Example data

Content-Type: application/json
{
  "subject" : "subject",
  "last_name" : "last_name",
  "message" : "message",
  "send_copy" : true,
  "first_name" : "first_name",
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Contact

Up
post /backend/sts/
(createCredentials)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Credentials Credentials (optional)
Body Parameter

Return type

Credentials

Example data

Content-Type: application/json
{
  "bucket" : "bucket",
  "access_key_id" : "access_key_id",
  "session_token" : "session_token",
  "endpoint" : "endpoint",
  "dtr" : 0,
  "file_name" : "file_name",
  "secret_access_key" : "secret_access_key",
  "action" : "read",
  "expiration" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Credentials

Up
post /backend/data-package/
(createDataPackage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataPackage DataPackage (optional)
Body Parameter

Return type

DataPackage

Example data

Content-Type: application/json
{
  "data_transfer" : "data_transfer",
  "metadata" : "metadata",
  "trace" : [ {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  }, {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  } ],
  "purpose" : "PRODUCTION",
  "destination_node" : "destination_node",
  "file_name" : "file_name",
  "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
  "metadata_hash" : "metadata_hash",
  "project_code" : "project_code",
  "data_provider" : "data_provider",
  "id" : 0,
  "file_size" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

DataPackage

Up
post /backend/data-package/log/
(createDataPackageTrace)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataPackageLog DataPackageLog (optional)
Body Parameter

Return type

DataPackageLog

Example data

Content-Type: application/json
{
  "node" : "node",
  "metadata" : "metadata",
  "file_name" : "file_name",
  "data_package" : "data_package",
  "id" : 0,
  "file_size" : 1,
  "timestamp" : "2000-01-23T04:56:07.000+00:00",
  "status" : "ENTER"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

DataPackageLog

Up
post /backend/data-provider/
(createDataProvider)
Authenticated users can list, data provider admins can update their data providers and (portal) staff can create and update any data provider.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataProvider DataProvider (optional)
Body Parameter

Return type

DataProvider

Example data

Content-Type: application/json
{
  "code" : "code",
  "nodes" : [ "nodes", "nodes" ],
  "coordinators" : [ {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "name" : "name",
  "id" : 0,
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

DataProvider

Up
post /backend/data-transfer/
(createDataTransfer)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataTransfer DataTransfer (optional)
Body Parameter

Return type

DataTransfer

Example data

Content-Type: application/json
{
  "purpose" : "PRODUCTION",
  "requestor_last_name" : "requestor_last_name",
  "change_date" : "2000-01-23T04:56:07.000+00:00",
  "project" : 4,
  "project_name" : "project_name",
  "node_approvals" : [ {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  }, {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  } ],
  "requestor_display_id" : "requestor_display_id",
  "project_archived" : true,
  "permissions" : {
    "edit" : {
      "data_specification" : true,
      "purpose" : true,
      "max_packages" : true,
      "legal_basis" : true,
      "data_recipients" : true,
      "data_provider" : true,
      "requestor" : true,
      "status" : true
    },
    "delete" : true
  },
  "requestor_name" : "requestor_name",
  "data_provider" : "data_provider",
  "id" : 0,
  "requestor_full_name" : "requestor_full_name",
  "data_specification" : "https://openapi-generator.tech",
  "legal_basis" : "legal_basis",
  "data_provider_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  } ],
  "creation_date" : "2000-01-23T04:56:07.000+00:00",
  "packages" : [ {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  }, {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  } ],
  "data_provider_name" : "data_provider_name",
  "requestor" : 1,
  "requestor_email" : "requestor_email",
  "group_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  } ],
  "max_packages" : 7,
  "data_recipients" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "requestor_first_name" : "requestor_first_name",
  "status" : "INITIAL"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

DataTransfer

Up
post /backend/feed/
(createFeed)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Feed Feed (optional)
Body Parameter

Return type

Feed

Example data

Content-Type: application/json
{
  "from_date" : "2000-01-23T04:56:07.000+00:00",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "label" : "INFO",
  "title" : "title",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Feed

Up
post /backend/flags/
(createFlag)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Flag Flag (optional)
Body Parameter

Return type

Flag

Example data

Content-Type: application/json
{
  "code" : "code",
  "description" : "description",
  "id" : 0,
  "users" : [ 6, 6 ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Flag

Up
post /backend/identity/group/
(createGroup)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Group Group (optional)
Body Parameter

Return type

Group

Example data

Content-Type: application/json
{
  "permissions_object" : [ {
    "objects" : [ 1, 1 ],
    "permission" : 5
  }, {
    "objects" : [ 1, 1 ],
    "permission" : 5
  } ],
  "permissions" : [ 1, 1 ],
  "profile" : {
    "role_entity_type" : "role_entity_type",
    "role_entity_id" : 6,
    "role" : "NA",
    "description" : "description"
  },
  "name" : "name",
  "id" : 0,
  "users" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Group

Up
post /backend/identity-provider/
(createIdentityProvider)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

IdentityProvider IdentityProvider (optional)
Body Parameter

Return type

IdentityProvider

Example data

Content-Type: application/json
{
  "code" : "code",
  "name" : "name",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

IdentityProvider

Up
post /backend/log/
(createLog)
Send user logs

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AnyType (optional)
Body Parameter

Return type

oas_any_type_not_mapped

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

oas_any_type_not_mapped

Up
post /backend/nodes/
(createNode)
Authenticated users can list, node admins can update their nodes and staff can create and update any node.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Node Node (optional)
Body Parameter

Return type

Node

Example data

Content-Type: application/json
{
  "code" : "code",
  "node_status" : "ON",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "ticketing_system_email" : "ticketing_system_email",
  "name" : "name",
  "oauth2_client" : 6,
  "id" : 0,
  "object_storage_url" : "https://openapi-generator.tech"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Node

Up
post /backend/open-pgp-keys/
(createPgpKeyInfo)
API endpoint that displays PGP key metadata info.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PgpKeyInfo PgpKeyInfo (optional)
Body Parameter

Return type

PgpKeyInfo

Example data

Content-Type: application/json
{
  "fingerprint" : "fingerprint",
  "id" : 0,
  "key_user_id" : "key_user_id",
  "key_email" : "key_email",
  "status" : "APPROVED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

PgpKeyInfo

Up
post /backend/projects/
(createProject)
Show, add, and modify projects.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Project Project (optional)
Body Parameter

Return type

Project

Example data

Content-Type: application/json
{
  "resources_support" : true,
  "gid" : 1801372,
  "code" : "code",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "user_has_role" : true,
  "destination" : "destination",
  "resources" : [ {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  }, {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  } ],
  "services_support" : true,
  "legal_approval_group" : 5,
  "legal_support_contact" : "legal_support_contact",
  "expiration_date" : "2000-01-23",
  "users" : [ {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  }, {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  } ],
  "archived" : true,
  "ssh_support" : true,
  "identity_provider" : 9,
  "additional_info" : "additional_info",
  "permissions" : {
    "edit" : {
      "resources_support" : true,
      "code" : true,
      "ip_address_ranges" : true,
      "destination" : true,
      "resources" : true,
      "services_support" : true,
      "legal_support_contact" : true,
      "legal_approval_group" : true,
      "expiration_date" : true,
      "users" : [ "USER", "USER" ],
      "ssh_support" : true,
      "identity_provider" : true,
      "additional_info" : true,
      "name" : true,
      "data_specification_approval_group" : true
    },
    "archive" : true
  },
  "name" : "name",
  "id" : 0,
  "data_specification_approval_group" : 5,
  "data_transfer_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Project

Up
post /backend/projects/{project_pk}/members/
(createProjectMemberList)

Path parameters

project_pk (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserLite UserLite (optional)
Body Parameter

Return type

UserLite

Example data

Content-Type: application/json
{
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "groups" : [ "groups", "groups" ],
  "last_name" : "last_name",
  "id" : 0,
  "display_name" : "display_name",
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

UserLite

Up
post /backend/projects/{project_pk}/members/{user_pk}/services/
(createProjectMemberServiceList)

Path parameters

project_pk (required)
Path Parameter — default: null
user_pk (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Service Service (optional)
Body Parameter

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Service

Up
post /backend/projects/{project_pk}/services/
(createProjectServiceList)

Path parameters

project_pk (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Service Service (optional)
Body Parameter

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Service

Up
post /backend/quick-accesses/
(createQuickAccessTile)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

QuickAccessTile QuickAccessTile (optional)
Body Parameter

Return type

QuickAccessTile

Example data

Content-Type: application/json
{
  "image" : "",
  "description" : "description",
  "id" : 0,
  "title" : "title",
  "url" : "https://openapi-generator.tech",
  "order" : 6732
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

QuickAccessTile

Up
post /backend/ssh-public-keys/
(createSSHPublicKey)
API endpoint for the users' SSH public keys.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SSHPublicKey SSHPublicKey (optional)
Body Parameter

Return type

SSHPublicKey

Example data

Content-Type: application/json
{
  "created" : "2000-01-23T04:56:07.000+00:00",
  "project" : 0,
  "id" : 6,
  "project_name" : "project_name",
  "user" : "user",
  "key" : "key",
  "changed" : "2000-01-23T04:56:07.000+00:00",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

SSHPublicKey

Up
post /backend/terms-of-use/
(createTermsOfUse)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TermsOfUse TermsOfUse (optional)
Body Parameter

Return type

TermsOfUse

Example data

Content-Type: application/json
{
  "node" : 6,
  "version_type" : "MINOR",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "text" : "text",
  "version" : "version",
  "users" : [ {
    "last_name" : "last_name",
    "first_name" : "first_name",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00",
    "email" : "email"
  }, {
    "last_name" : "last_name",
    "first_name" : "first_name",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00",
    "email" : "email"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

TermsOfUse

Up
post /backend/terms-of-use-acceptance/
(createTermsOfUseAcceptance)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TermsOfUseAcceptance TermsOfUseAcceptance (optional)
Body Parameter

Return type

TermsOfUseAcceptance

Example data

Content-Type: application/json
{
  "terms_of_use" : 6,
  "user" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

TermsOfUseAcceptance

Up
post /backend/users/
(createUser)
Show details of registered users.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

User User (optional)
Body Parameter

Return type

User

Example data

Content-Type: application/json
{
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "profile" : {
    "emails" : "emails",
    "uid" : 1073290,
    "gid" : 1298106,
    "display_local_username" : "display_local_username",
    "affiliation" : "affiliation",
    "display_id" : "display_id",
    "custom_affiliation" : 5,
    "namespace" : "namespace",
    "affiliation_consent" : true,
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name"
  },
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "flags" : [ "flags", "flags" ],
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "terms_of_use" : [ {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "display_name" : "display_name",
  "id" : 0,
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

User

Up
post /backend/terminology/versionfile/download/
(createVersionFile)
Download file of a version (read-only POST)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VersionFileDownload VersionFileDownload (optional)
Body Parameter

Return type

File

Example data

Content-Type: application/json
{
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

VersionFileDownload

200

File download File

Up
delete /backend/data-package/{id}/
(destroyDataPackage)

Path parameters

id (required)
Path Parameter — default: null

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Responses

204


Up
delete /backend/data-provider/{id}/
(destroyDataProvider)
Authenticated users can list, data provider admins can update their data providers and (portal) staff can create and update any data provider.

Path parameters

id (required)
Path Parameter — default: null

Query parameters

username (optional)
Query Parameter — Only returns data providers which the user has permission to view or edit. default: null

Responses

204


Up
delete /backend/data-transfer/{id}/
(destroyDataTransfer)

Path parameters

id (required)
Path Parameter — default: null

Responses

204


Up
delete /backend/feed/{id}/
(destroyFeed)

Path parameters

id (required)
Path Parameter — default: null

Responses

204


Up
delete /backend/flags/{id}/
(destroyFlag)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this flag. default: null

Responses

204


Up
delete /backend/identity/group/{id}/
(destroyGroup)

Path parameters

id (required)
Path Parameter — default: null

Query parameters

role (optional)
Query Parameter — Includes only groups with specified role default: null
role_entity_id (optional)
Query Parameter — Includes only groups with specified role_entity_id default: null
role_entity_type (optional)
Query Parameter — Includes only groups with specified role_entity_type default: null
managed (optional)
Query Parameter — Returns only groups managed by the user default: null

Responses

204


Up
delete /backend/identity-provider/{id}/
(destroyIdentityProvider)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this identity provider. default: null

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Responses

204


Up
delete /backend/nodes/{id}/
(destroyNode)
Authenticated users can list, node admins can update their nodes and staff can create and update any node.

Path parameters

id (required)
Path Parameter — A unique integer value identifying this node. default: null

Query parameters

username (optional)
Query Parameter — Only returns nodes which the user has permission to view or edit. default: null

Responses

204


Up
delete /backend/projects/{id}/
(destroyProject)
Show, add, and modify projects.

Path parameters

id (required)
Path Parameter — default: null

Query parameters

search (optional)
Query Parameter — A search term. default: null
ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null
username (optional)
Query Parameter — Username for the User Role default: null
destination (optional)
Query Parameter — Includes only projects with specified destination default: null
code (optional)
Query Parameter — Includes only the project identified by specified code default: null
name (optional)
Query Parameter — Includes only the project identified by specified name default: null

Responses

204


Up
delete /backend/projects/{project_pk}/members/{id}/
(destroyProjectMember)

Path parameters

project_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Responses

204


Up
delete /backend/projects/{project_pk}/members/{user_pk}/services/{id}/
(destroyProjectMemberService)

Path parameters

project_pk (required)
Path Parameter — default: null
user_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Responses

204


Up
delete /backend/projects/{project_pk}/services/{id}/
(destroyProjectService)

Path parameters

project_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Responses

204


Up
delete /backend/quick-accesses/{id}/
(destroyQuickAccessTile)

Path parameters

id (required)
Path Parameter — default: null

Responses

204


Up
delete /backend/ssh-public-keys/{id}/
(destroySSHPublicKey)
API endpoint for the users' SSH public keys.

Path parameters

id (required)
Path Parameter — default: null

Responses

204


Up
delete /backend/services/{id}/
(destroyService)

Service endpoint.

Note that creation does NOT happen via this endpoint.

Path parameters

id (required)
Path Parameter — A unique integer value identifying this service. default: null

Query parameters

name (optional)
Query Parameter — Includes only services with specified name default: null

Responses

204


Up
delete /backend/terms-of-use/{id}/
(destroyTermsOfUse)

Path parameters

id (required)
Path Parameter — default: null

Responses

204


Up
get /backend/custom-affiliations/
(listCustomAffiliations)
Organisations that are not (yet) part of SWITCH edu-ID

Query parameters

code (optional)
Query Parameter — Includes only custom affiliations with specified code default: null

Return type

array[CustomAffiliation]

Example data

Content-Type: application/json
[ {
  "code" : "code",
  "name" : "name",
  "id" : 0
}, {
  "code" : "code",
  "name" : "name",
  "id" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/data-package/
(listDataPackages)

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Return type

array[DataPackage]

Example data

Content-Type: application/json
[ {
  "data_transfer" : "data_transfer",
  "metadata" : "metadata",
  "trace" : [ {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  }, {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  } ],
  "purpose" : "PRODUCTION",
  "destination_node" : "destination_node",
  "file_name" : "file_name",
  "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
  "metadata_hash" : "metadata_hash",
  "project_code" : "project_code",
  "data_provider" : "data_provider",
  "id" : 0,
  "file_size" : 6
}, {
  "data_transfer" : "data_transfer",
  "metadata" : "metadata",
  "trace" : [ {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  }, {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  } ],
  "purpose" : "PRODUCTION",
  "destination_node" : "destination_node",
  "file_name" : "file_name",
  "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
  "metadata_hash" : "metadata_hash",
  "project_code" : "project_code",
  "data_provider" : "data_provider",
  "id" : 0,
  "file_size" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/data-provider/
(listDataProviders)
Authenticated users can list, data provider admins can update their data providers and (portal) staff can create and update any data provider.

Query parameters

username (optional)
Query Parameter — Only returns data providers which the user has permission to view or edit. default: null

Return type

array[DataProvider]

Example data

Content-Type: application/json
[ {
  "code" : "code",
  "nodes" : [ "nodes", "nodes" ],
  "coordinators" : [ {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "name" : "name",
  "id" : 0,
  "enabled" : true
}, {
  "code" : "code",
  "nodes" : [ "nodes", "nodes" ],
  "coordinators" : [ {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "name" : "name",
  "id" : 0,
  "enabled" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/data-transfer/
(listDataTransferLites)

Return type

array[DataTransferLite]

Example data

Content-Type: application/json
[ {
  "requestor_full_name" : "requestor_full_name",
  "purpose" : "PRODUCTION",
  "data_provider_code" : "data_provider_code",
  "change_date" : "2000-01-23T04:56:07.000+00:00",
  "max_packages" : 6,
  "project" : "project",
  "id" : 0,
  "data_provider_name" : "data_provider_name",
  "packages" : [ {
    "file_name" : "file_name"
  }, {
    "file_name" : "file_name"
  } ],
  "project_name" : "project_name",
  "status" : "INITIAL"
}, {
  "requestor_full_name" : "requestor_full_name",
  "purpose" : "PRODUCTION",
  "data_provider_code" : "data_provider_code",
  "change_date" : "2000-01-23T04:56:07.000+00:00",
  "max_packages" : 6,
  "project" : "project",
  "id" : 0,
  "data_provider_name" : "data_provider_name",
  "packages" : [ {
    "file_name" : "file_name"
  }, {
    "file_name" : "file_name"
  } ],
  "project_name" : "project_name",
  "status" : "INITIAL"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/exports/data-transfers
(listDataTransfersExports)

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Export Data Transfer Requests as CSV String

Up
get /backend/terminology/downloaded_file/
(listDownloadedFiles)

Return type

array[DownloadedFile]

Example data

Content-Type: application/json
[ {
  "created" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "user" : "user",
  "version_file" : {
    "file" : "",
    "id" : 6,
    "version" : {
      "terminology" : {
        "copyright" : "copyright",
        "code" : "code",
        "contact" : "contact",
        "documentation" : "documentation",
        "name" : "name",
        "description" : "description",
        "id" : 5,
        "confirmation_checkbox_text" : "confirmation_checkbox_text",
        "confirmation_description" : "confirmation_description"
      },
      "name" : "name",
      "id" : 1,
      "released" : "2000-01-23",
      "status" : "ACTIVE"
    }
  }
}, {
  "created" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "user" : "user",
  "version_file" : {
    "file" : "",
    "id" : 6,
    "version" : {
      "terminology" : {
        "copyright" : "copyright",
        "code" : "code",
        "contact" : "contact",
        "documentation" : "documentation",
        "name" : "name",
        "description" : "description",
        "id" : 5,
        "confirmation_checkbox_text" : "confirmation_checkbox_text",
        "confirmation_description" : "confirmation_description"
      },
      "name" : "name",
      "id" : 1,
      "released" : "2000-01-23",
      "status" : "ACTIVE"
    }
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/feed/
(listFeeds)

Return type

array[Feed]

Example data

Content-Type: application/json
[ {
  "from_date" : "2000-01-23T04:56:07.000+00:00",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "label" : "INFO",
  "title" : "title",
  "message" : "message"
}, {
  "from_date" : "2000-01-23T04:56:07.000+00:00",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "label" : "INFO",
  "title" : "title",
  "message" : "message"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/flags/
(listFlags)

Return type

array[Flag]

Example data

Content-Type: application/json
[ {
  "code" : "code",
  "description" : "description",
  "id" : 0,
  "users" : [ 6, 6 ]
}, {
  "code" : "code",
  "description" : "description",
  "id" : 0,
  "users" : [ 6, 6 ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/identity/group/
(listGroups)

Query parameters

role (optional)
Query Parameter — Includes only groups with specified role default: null
role_entity_id (optional)
Query Parameter — Includes only groups with specified role_entity_id default: null
role_entity_type (optional)
Query Parameter — Includes only groups with specified role_entity_type default: null
managed (optional)
Query Parameter — Returns only groups managed by the user default: null

Return type

array[Group]

Example data

Content-Type: application/json
[ {
  "permissions_object" : [ {
    "objects" : [ 1, 1 ],
    "permission" : 5
  }, {
    "objects" : [ 1, 1 ],
    "permission" : 5
  } ],
  "permissions" : [ 1, 1 ],
  "profile" : {
    "role_entity_type" : "role_entity_type",
    "role_entity_id" : 6,
    "role" : "NA",
    "description" : "description"
  },
  "name" : "name",
  "id" : 0,
  "users" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ]
}, {
  "permissions_object" : [ {
    "objects" : [ 1, 1 ],
    "permission" : 5
  }, {
    "objects" : [ 1, 1 ],
    "permission" : 5
  } ],
  "permissions" : [ 1, 1 ],
  "profile" : {
    "role_entity_type" : "role_entity_type",
    "role_entity_id" : 6,
    "role" : "NA",
    "description" : "description"
  },
  "name" : "name",
  "id" : 0,
  "users" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/identity-provider/
(listIdentityProviders)

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Return type

array[IdentityProvider]

Example data

Content-Type: application/json
[ {
  "code" : "code",
  "name" : "name",
  "id" : 0
}, {
  "code" : "code",
  "name" : "name",
  "id" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/nodes/
(listNodes)
Authenticated users can list, node admins can update their nodes and staff can create and update any node.

Query parameters

username (optional)
Query Parameter — Only returns nodes which the user has permission to view or edit. default: null

Return type

array[Node]

Example data

Content-Type: application/json
[ {
  "code" : "code",
  "node_status" : "ON",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "ticketing_system_email" : "ticketing_system_email",
  "name" : "name",
  "oauth2_client" : 6,
  "id" : 0,
  "object_storage_url" : "https://openapi-generator.tech"
}, {
  "code" : "code",
  "node_status" : "ON",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "ticketing_system_email" : "ticketing_system_email",
  "name" : "name",
  "oauth2_client" : 6,
  "id" : 0,
  "object_storage_url" : "https://openapi-generator.tech"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/oauth2-clients/
(listOAuth2Clients)

Return type

array[OAuth2Client]

Example data

Content-Type: application/json
[ {
  "id" : 0,
  "redirect_uri" : "redirect_uri",
  "client_name" : "client_name"
}, {
  "id" : 0,
  "redirect_uri" : "redirect_uri",
  "client_name" : "client_name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/identity/object_by_permission/
(listObjectByPermissionViewSets)

Query parameters

perm_id (required)
Query Parameter — Permission ids for which available objects should be returned default: null

Return type

array[oas_any_type_not_mapped]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/identity/permission/
(listPermissions)

Return type

array[Permission]

Example data

Content-Type: application/json
[ {
  "content_type" : 6,
  "codename" : "codename",
  "name" : "name",
  "id" : 0
}, {
  "content_type" : 6,
  "codename" : "codename",
  "name" : "name",
  "id" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/open-pgp-keys/
(listPgpKeyInfos)
API endpoint that displays PGP key metadata info.

Query parameters

fingerprint (optional)
Query Parameter — Includes only info about OpenPGP keys with specified fingerprint default: null
key_email (optional)
Query Parameter — Includes only info about OpenPGP keys verified with specified email default: null
key_user_id (optional)
Query Parameter — Includes only info about OpenPGP keys with User ID default: null
status (optional)
Query Parameter — Includes only info about OpenPGP keys in specified status default: null
username (optional)
Query Parameter — Includes only info about OpenPGP keys associated to user with specified username default: null

Return type

array[PgpKeyInfo]

Example data

Content-Type: application/json
[ {
  "fingerprint" : "fingerprint",
  "id" : 0,
  "key_user_id" : "key_user_id",
  "key_email" : "key_email",
  "status" : "APPROVED"
}, {
  "fingerprint" : "fingerprint",
  "id" : 0,
  "key_user_id" : "key_user_id",
  "key_email" : "key_email",
  "status" : "APPROVED"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/audit/project-permission/
(listProjectUserRoleHistories)

Query parameters

from (optional)
Query Parameter — Includes only entries created after specified date default: null
to (optional)
Query Parameter — Includes only entries created before specified date default: null
project (optional)
Query Parameter — Includes only entries whose project code matches the specified regex default: null

Return type

array[ProjectUserRoleHistory]

Example data

Content-Type: application/json
[ {
  "changed_by" : "changed_by",
  "project" : "project",
  "permission" : "permission",
  "user" : "user",
  "enabled" : true,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
  "changed_by" : "changed_by",
  "project" : "project",
  "permission" : "permission",
  "user" : "user",
  "enabled" : true,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/projects/
(listProjects)
Show, add, and modify projects.

Query parameters

search (optional)
Query Parameter — A search term. default: null
ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null
username (optional)
Query Parameter — Username for the User Role default: null
destination (optional)
Query Parameter — Includes only projects with specified destination default: null
code (optional)
Query Parameter — Includes only the project identified by specified code default: null
name (optional)
Query Parameter — Includes only the project identified by specified name default: null

Return type

array[Project]

Example data

Content-Type: application/json
[ {
  "resources_support" : true,
  "gid" : 1801372,
  "code" : "code",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "user_has_role" : true,
  "destination" : "destination",
  "resources" : [ {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  }, {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  } ],
  "services_support" : true,
  "legal_approval_group" : 5,
  "legal_support_contact" : "legal_support_contact",
  "expiration_date" : "2000-01-23",
  "users" : [ {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  }, {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  } ],
  "archived" : true,
  "ssh_support" : true,
  "identity_provider" : 9,
  "additional_info" : "additional_info",
  "permissions" : {
    "edit" : {
      "resources_support" : true,
      "code" : true,
      "ip_address_ranges" : true,
      "destination" : true,
      "resources" : true,
      "services_support" : true,
      "legal_support_contact" : true,
      "legal_approval_group" : true,
      "expiration_date" : true,
      "users" : [ "USER", "USER" ],
      "ssh_support" : true,
      "identity_provider" : true,
      "additional_info" : true,
      "name" : true,
      "data_specification_approval_group" : true
    },
    "archive" : true
  },
  "name" : "name",
  "id" : 0,
  "data_specification_approval_group" : 5,
  "data_transfer_count" : 1
}, {
  "resources_support" : true,
  "gid" : 1801372,
  "code" : "code",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "user_has_role" : true,
  "destination" : "destination",
  "resources" : [ {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  }, {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  } ],
  "services_support" : true,
  "legal_approval_group" : 5,
  "legal_support_contact" : "legal_support_contact",
  "expiration_date" : "2000-01-23",
  "users" : [ {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  }, {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  } ],
  "archived" : true,
  "ssh_support" : true,
  "identity_provider" : 9,
  "additional_info" : "additional_info",
  "permissions" : {
    "edit" : {
      "resources_support" : true,
      "code" : true,
      "ip_address_ranges" : true,
      "destination" : true,
      "resources" : true,
      "services_support" : true,
      "legal_support_contact" : true,
      "legal_approval_group" : true,
      "expiration_date" : true,
      "users" : [ "USER", "USER" ],
      "ssh_support" : true,
      "identity_provider" : true,
      "additional_info" : true,
      "name" : true,
      "data_specification_approval_group" : true
    },
    "archive" : true
  },
  "name" : "name",
  "id" : 0,
  "data_specification_approval_group" : 5,
  "data_transfer_count" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/quick-accesses/
(listQuickAccessTiles)

Return type

array[QuickAccessTile]

Example data

Content-Type: application/json
[ {
  "image" : "",
  "description" : "description",
  "id" : 0,
  "title" : "title",
  "url" : "https://openapi-generator.tech",
  "order" : 6732
}, {
  "image" : "",
  "description" : "description",
  "id" : 0,
  "title" : "title",
  "url" : "https://openapi-generator.tech",
  "order" : 6732
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/ssh-public-keys/
(listSSHPublicKeys)
API endpoint for the users' SSH public keys.

Return type

array[SSHPublicKey]

Example data

Content-Type: application/json
[ {
  "created" : "2000-01-23T04:56:07.000+00:00",
  "project" : 0,
  "id" : 6,
  "project_name" : "project_name",
  "user" : "user",
  "key" : "key",
  "changed" : "2000-01-23T04:56:07.000+00:00",
  "username" : "username"
}, {
  "created" : "2000-01-23T04:56:07.000+00:00",
  "project" : 0,
  "id" : 6,
  "project_name" : "project_name",
  "user" : "user",
  "key" : "key",
  "changed" : "2000-01-23T04:56:07.000+00:00",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/services/
(listServices)

Service endpoint.

Note that creation does NOT happen via this endpoint.

Query parameters

name (optional)
Query Parameter — Includes only services with specified name default: null

Return type

array[Service]

Example data

Content-Type: application/json
[ {
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}, {
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/terminology/terminology/
(listTerminologies)

Return type

array[Terminology]

Example data

Content-Type: application/json
[ {
  "copyright" : "copyright",
  "code" : "code",
  "versions" : [ {
    "name" : "name",
    "files" : [ {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    }, {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    } ],
    "id" : 6,
    "released" : "2000-01-23",
    "status" : "ACTIVE"
  }, {
    "name" : "name",
    "files" : [ {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    }, {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    } ],
    "id" : 6,
    "released" : "2000-01-23",
    "status" : "ACTIVE"
  } ],
  "contact" : "contact",
  "documentation" : "documentation",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "confirmation_checkbox_text" : "confirmation_checkbox_text",
  "confirmation_description" : "confirmation_description"
}, {
  "copyright" : "copyright",
  "code" : "code",
  "versions" : [ {
    "name" : "name",
    "files" : [ {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    }, {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    } ],
    "id" : 6,
    "released" : "2000-01-23",
    "status" : "ACTIVE"
  }, {
    "name" : "name",
    "files" : [ {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    }, {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    } ],
    "id" : 6,
    "released" : "2000-01-23",
    "status" : "ACTIVE"
  } ],
  "contact" : "contact",
  "documentation" : "documentation",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "confirmation_checkbox_text" : "confirmation_checkbox_text",
  "confirmation_description" : "confirmation_description"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/terms-of-use/
(listTermsOfUseLites)

Return type

array[TermsOfUseLite]

Example data

Content-Type: application/json
[ {
  "node" : 6,
  "version_type" : "MINOR",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "text" : "text",
  "version" : "version"
}, {
  "node" : 6,
  "version_type" : "MINOR",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "text" : "text",
  "version" : "version"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/users/
(listUserLites)
Show details of registered users.

Query parameters

include_inactive (optional)
Query Parameter — Includes users which are not active (is_active is False) default: null
project_id (optional)
Query Parameter — Only includes users which have at least one role in this project. default: null
role (optional)
Query Parameter — Only includes users which have at least this role in any project. default: null
first_name (optional)
Query Parameter — Includes only users with specified first name default: null
last_name (optional)
Query Parameter — Includes only users with specified last name default: null
affiliation (optional)
Query Parameter — Includes only users for whom at least one of the linked affiliations matches (or contains) the provided string default: null
username (optional)
Query Parameter — Includes only users with specified username default: null
email (optional)
Query Parameter — Returns the first user matching given email address. We first try to exactly match the official (or main) email address. As fallback we scan the provided of additional email addresses. default: null

Return type

array[UserLite]

Example data

Content-Type: application/json
[ {
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "groups" : [ "groups", "groups" ],
  "last_name" : "last_name",
  "id" : 0,
  "display_name" : "display_name",
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}, {
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "groups" : [ "groups", "groups" ],
  "last_name" : "last_name",
  "id" : 0,
  "display_name" : "display_name",
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/user-namespaces/
(listUserNamespaces)
View available namespaces.

Return type

array[UserNamespace]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "id" : 0
}, {
  "name" : "name",
  "id" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/exports/users
(listUsersExports)

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Export Users as CSV String

Up
get /backend/exports/terms-of-use
(listUsersTermsOfUseExports)

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Export All Users Who Accepted Any Terms of Use as CSV String

Up
post /backend/open-pgp-keys/metadata/
(metadataPgpKeyMetadata)
API endpoint that displays PGP key metadata info.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PgpKeyMetadata PgpKeyMetadata (optional)
Body Parameter

Return type

PgpKeyMetadata

Example data

Content-Type: application/json
{
  "user_id" : "user_id",
  "status_info" : "status_info",
  "fingerprint" : "fingerprint",
  "error" : "error",
  "email" : "email",
  "status" : "EXPIRED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

PgpKeyMetadata

Up
get /backend/identity/permission/{id}/objects/
(objectsAnyObject)

Path parameters

id (required)
Path Parameter — default: null

Return type

array[AnyObject]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "id" : 1
}, {
  "name" : "name",
  "id" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
patch /backend/approval/{id}/
(partialUpdateApproval)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Approval Approval (optional)
Body Parameter

Return type

DataTransfer

Example data

Content-Type: application/json
{
  "purpose" : "PRODUCTION",
  "requestor_last_name" : "requestor_last_name",
  "change_date" : "2000-01-23T04:56:07.000+00:00",
  "project" : 4,
  "project_name" : "project_name",
  "node_approvals" : [ {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  }, {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  } ],
  "requestor_display_id" : "requestor_display_id",
  "project_archived" : true,
  "permissions" : {
    "edit" : {
      "data_specification" : true,
      "purpose" : true,
      "max_packages" : true,
      "legal_basis" : true,
      "data_recipients" : true,
      "data_provider" : true,
      "requestor" : true,
      "status" : true
    },
    "delete" : true
  },
  "requestor_name" : "requestor_name",
  "data_provider" : "data_provider",
  "id" : 0,
  "requestor_full_name" : "requestor_full_name",
  "data_specification" : "https://openapi-generator.tech",
  "legal_basis" : "legal_basis",
  "data_provider_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  } ],
  "creation_date" : "2000-01-23T04:56:07.000+00:00",
  "packages" : [ {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  }, {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  } ],
  "data_provider_name" : "data_provider_name",
  "requestor" : 1,
  "requestor_email" : "requestor_email",
  "group_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  } ],
  "max_packages" : 7,
  "data_recipients" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "requestor_first_name" : "requestor_first_name",
  "status" : "INITIAL"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataTransfer

Up
patch /backend/data-package/{id}/
(partialUpdateDataPackage)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataPackage DataPackage (optional)
Body Parameter

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Return type

DataPackage

Example data

Content-Type: application/json
{
  "data_transfer" : "data_transfer",
  "metadata" : "metadata",
  "trace" : [ {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  }, {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  } ],
  "purpose" : "PRODUCTION",
  "destination_node" : "destination_node",
  "file_name" : "file_name",
  "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
  "metadata_hash" : "metadata_hash",
  "project_code" : "project_code",
  "data_provider" : "data_provider",
  "id" : 0,
  "file_size" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataPackage

Up
patch /backend/data-provider/{id}/
(partialUpdateDataProvider)
Authenticated users can list, data provider admins can update their data providers and (portal) staff can create and update any data provider.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataProvider DataProvider (optional)
Body Parameter

Query parameters

username (optional)
Query Parameter — Only returns data providers which the user has permission to view or edit. default: null

Return type

DataProvider

Example data

Content-Type: application/json
{
  "code" : "code",
  "nodes" : [ "nodes", "nodes" ],
  "coordinators" : [ {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "name" : "name",
  "id" : 0,
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataProvider

Up
patch /backend/data-transfer/{id}/
(partialUpdateDataTransfer)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataTransfer DataTransfer (optional)
Body Parameter

Return type

DataTransfer

Example data

Content-Type: application/json
{
  "purpose" : "PRODUCTION",
  "requestor_last_name" : "requestor_last_name",
  "change_date" : "2000-01-23T04:56:07.000+00:00",
  "project" : 4,
  "project_name" : "project_name",
  "node_approvals" : [ {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  }, {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  } ],
  "requestor_display_id" : "requestor_display_id",
  "project_archived" : true,
  "permissions" : {
    "edit" : {
      "data_specification" : true,
      "purpose" : true,
      "max_packages" : true,
      "legal_basis" : true,
      "data_recipients" : true,
      "data_provider" : true,
      "requestor" : true,
      "status" : true
    },
    "delete" : true
  },
  "requestor_name" : "requestor_name",
  "data_provider" : "data_provider",
  "id" : 0,
  "requestor_full_name" : "requestor_full_name",
  "data_specification" : "https://openapi-generator.tech",
  "legal_basis" : "legal_basis",
  "data_provider_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  } ],
  "creation_date" : "2000-01-23T04:56:07.000+00:00",
  "packages" : [ {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  }, {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  } ],
  "data_provider_name" : "data_provider_name",
  "requestor" : 1,
  "requestor_email" : "requestor_email",
  "group_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  } ],
  "max_packages" : 7,
  "data_recipients" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "requestor_first_name" : "requestor_first_name",
  "status" : "INITIAL"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataTransfer

Up
patch /backend/feed/{id}/
(partialUpdateFeed)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Feed Feed (optional)
Body Parameter

Return type

Feed

Example data

Content-Type: application/json
{
  "from_date" : "2000-01-23T04:56:07.000+00:00",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "label" : "INFO",
  "title" : "title",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Feed

Up
patch /backend/flags/{id}/
(partialUpdateFlag)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this flag. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Flag Flag (optional)
Body Parameter

Return type

Flag

Example data

Content-Type: application/json
{
  "code" : "code",
  "description" : "description",
  "id" : 0,
  "users" : [ 6, 6 ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Flag

Up
patch /backend/identity/group/{id}/
(partialUpdateGroup)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Group Group (optional)
Body Parameter

Query parameters

role (optional)
Query Parameter — Includes only groups with specified role default: null
role_entity_id (optional)
Query Parameter — Includes only groups with specified role_entity_id default: null
role_entity_type (optional)
Query Parameter — Includes only groups with specified role_entity_type default: null
managed (optional)
Query Parameter — Returns only groups managed by the user default: null

Return type

Group

Example data

Content-Type: application/json
{
  "permissions_object" : [ {
    "objects" : [ 1, 1 ],
    "permission" : 5
  }, {
    "objects" : [ 1, 1 ],
    "permission" : 5
  } ],
  "permissions" : [ 1, 1 ],
  "profile" : {
    "role_entity_type" : "role_entity_type",
    "role_entity_id" : 6,
    "role" : "NA",
    "description" : "description"
  },
  "name" : "name",
  "id" : 0,
  "users" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Group

Up
patch /backend/identity-provider/{id}/
(partialUpdateIdentityProvider)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this identity provider. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

IdentityProvider IdentityProvider (optional)
Body Parameter

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Return type

IdentityProvider

Example data

Content-Type: application/json
{
  "code" : "code",
  "name" : "name",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

IdentityProvider

Up
patch /backend/nodes/{id}/
(partialUpdateNode)
Authenticated users can list, node admins can update their nodes and staff can create and update any node.

Path parameters

id (required)
Path Parameter — A unique integer value identifying this node. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Node Node (optional)
Body Parameter

Query parameters

username (optional)
Query Parameter — Only returns nodes which the user has permission to view or edit. default: null

Return type

Node

Example data

Content-Type: application/json
{
  "code" : "code",
  "node_status" : "ON",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "ticketing_system_email" : "ticketing_system_email",
  "name" : "name",
  "oauth2_client" : 6,
  "id" : 0,
  "object_storage_url" : "https://openapi-generator.tech"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Node

Up
patch /backend/open-pgp-keys/{id}/
(partialUpdatePgpKeyInfo)
API endpoint that displays PGP key metadata info.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PgpKeyInfo PgpKeyInfo (optional)
Body Parameter

Query parameters

fingerprint (optional)
Query Parameter — Includes only info about OpenPGP keys with specified fingerprint default: null
key_email (optional)
Query Parameter — Includes only info about OpenPGP keys verified with specified email default: null
key_user_id (optional)
Query Parameter — Includes only info about OpenPGP keys with User ID default: null
status (optional)
Query Parameter — Includes only info about OpenPGP keys in specified status default: null
username (optional)
Query Parameter — Includes only info about OpenPGP keys associated to user with specified username default: null

Return type

PgpKeyInfo

Example data

Content-Type: application/json
{
  "fingerprint" : "fingerprint",
  "id" : 0,
  "key_user_id" : "key_user_id",
  "key_email" : "key_email",
  "status" : "APPROVED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PgpKeyInfo

Up
patch /backend/projects/{id}/
(partialUpdateProject)
Show, add, and modify projects.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Project Project (optional)
Body Parameter

Query parameters

search (optional)
Query Parameter — A search term. default: null
ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null
username (optional)
Query Parameter — Username for the User Role default: null
destination (optional)
Query Parameter — Includes only projects with specified destination default: null
code (optional)
Query Parameter — Includes only the project identified by specified code default: null
name (optional)
Query Parameter — Includes only the project identified by specified name default: null

Return type

Project

Example data

Content-Type: application/json
{
  "resources_support" : true,
  "gid" : 1801372,
  "code" : "code",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "user_has_role" : true,
  "destination" : "destination",
  "resources" : [ {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  }, {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  } ],
  "services_support" : true,
  "legal_approval_group" : 5,
  "legal_support_contact" : "legal_support_contact",
  "expiration_date" : "2000-01-23",
  "users" : [ {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  }, {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  } ],
  "archived" : true,
  "ssh_support" : true,
  "identity_provider" : 9,
  "additional_info" : "additional_info",
  "permissions" : {
    "edit" : {
      "resources_support" : true,
      "code" : true,
      "ip_address_ranges" : true,
      "destination" : true,
      "resources" : true,
      "services_support" : true,
      "legal_support_contact" : true,
      "legal_approval_group" : true,
      "expiration_date" : true,
      "users" : [ "USER", "USER" ],
      "ssh_support" : true,
      "identity_provider" : true,
      "additional_info" : true,
      "name" : true,
      "data_specification_approval_group" : true
    },
    "archive" : true
  },
  "name" : "name",
  "id" : 0,
  "data_specification_approval_group" : 5,
  "data_transfer_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Project

Up
patch /backend/projects/{project_pk}/members/{id}/
(partialUpdateProjectMember)

Path parameters

project_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserLite UserLite (optional)
Body Parameter

Return type

UserLite

Example data

Content-Type: application/json
{
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "groups" : [ "groups", "groups" ],
  "last_name" : "last_name",
  "id" : 0,
  "display_name" : "display_name",
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

UserLite

Up
patch /backend/projects/{project_pk}/members/{user_pk}/services/{id}/
(partialUpdateProjectMemberService)

Path parameters

project_pk (required)
Path Parameter — default: null
user_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Service Service (optional)
Body Parameter

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service

Up
patch /backend/projects/{project_pk}/services/{id}/
(partialUpdateProjectService)

Path parameters

project_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Service Service (optional)
Body Parameter

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service

Up
patch /backend/quick-accesses/{id}/
(partialUpdateQuickAccessTile)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

QuickAccessTile QuickAccessTile (optional)
Body Parameter

Return type

QuickAccessTile

Example data

Content-Type: application/json
{
  "image" : "",
  "description" : "description",
  "id" : 0,
  "title" : "title",
  "url" : "https://openapi-generator.tech",
  "order" : 6732
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

QuickAccessTile

Up
patch /backend/ssh-public-keys/{id}/
(partialUpdateSSHPublicKey)
API endpoint for the users' SSH public keys.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SSHPublicKey SSHPublicKey (optional)
Body Parameter

Return type

SSHPublicKey

Example data

Content-Type: application/json
{
  "created" : "2000-01-23T04:56:07.000+00:00",
  "project" : 0,
  "id" : 6,
  "project_name" : "project_name",
  "user" : "user",
  "key" : "key",
  "changed" : "2000-01-23T04:56:07.000+00:00",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

SSHPublicKey

Up
patch /backend/services/{id}/
(partialUpdateService)

Service endpoint.

Note that creation does NOT happen via this endpoint.

Path parameters

id (required)
Path Parameter — A unique integer value identifying this service. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Service Service (optional)
Body Parameter

Query parameters

name (optional)
Query Parameter — Includes only services with specified name default: null

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service

Up
patch /backend/terms-of-use/{id}/
(partialUpdateTermsOfUse)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TermsOfUse TermsOfUse (optional)
Body Parameter

Return type

TermsOfUse

Example data

Content-Type: application/json
{
  "node" : 6,
  "version_type" : "MINOR",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "text" : "text",
  "version" : "version",
  "users" : [ {
    "last_name" : "last_name",
    "first_name" : "first_name",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00",
    "email" : "email"
  }, {
    "last_name" : "last_name",
    "first_name" : "first_name",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00",
    "email" : "email"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

TermsOfUse

Up
patch /backend/users/{id}/
(partialUpdateUser)
Show details of registered users.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

User User (optional)
Body Parameter

Query parameters

include_inactive (optional)
Query Parameter — Includes users which are not active (is_active is False) default: null
project_id (optional)
Query Parameter — Only includes users which have at least one role in this project. default: null
role (optional)
Query Parameter — Only includes users which have at least this role in any project. default: null
first_name (optional)
Query Parameter — Includes only users with specified first name default: null
last_name (optional)
Query Parameter — Includes only users with specified last name default: null
affiliation (optional)
Query Parameter — Includes only users for whom at least one of the linked affiliations matches (or contains) the provided string default: null
username (optional)
Query Parameter — Includes only users with specified username default: null
email (optional)
Query Parameter — Returns the first user matching given email address. We first try to exactly match the official (or main) email address. As fallback we scan the provided of additional email addresses. default: null

Return type

User

Example data

Content-Type: application/json
{
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "profile" : {
    "emails" : "emails",
    "uid" : 1073290,
    "gid" : 1298106,
    "display_local_username" : "display_local_username",
    "affiliation" : "affiliation",
    "display_id" : "display_id",
    "custom_affiliation" : 5,
    "namespace" : "namespace",
    "affiliation_consent" : true,
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name"
  },
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "flags" : [ "flags", "flags" ],
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "terms_of_use" : [ {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "display_name" : "display_name",
  "id" : 0,
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

User

Up
post /backend/open-pgp-keys/{id}/retire/
(retirePgpKeyInfo)
API endpoint that displays PGP key metadata info.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PgpKeyInfo PgpKeyInfo (optional)
Body Parameter

Return type

PgpKeyInfo

Example data

Content-Type: application/json
{
  "fingerprint" : "fingerprint",
  "id" : 0,
  "key_user_id" : "key_user_id",
  "key_email" : "key_email",
  "status" : "APPROVED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

PgpKeyInfo

Up
get /backend/custom-affiliations/{id}/
(retrieveCustomAffiliation)
Organisations that are not (yet) part of SWITCH edu-ID

Path parameters

id (required)
Path Parameter — A unique integer value identifying this custom affiliation. default: null

Query parameters

code (optional)
Query Parameter — Includes only custom affiliations with specified code default: null

Return type

CustomAffiliation

Example data

Content-Type: application/json
{
  "code" : "code",
  "name" : "name",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

CustomAffiliation

Up
get /backend/data-package/{id}/
(retrieveDataPackage)

Path parameters

id (required)
Path Parameter — default: null

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Return type

DataPackage

Example data

Content-Type: application/json
{
  "data_transfer" : "data_transfer",
  "metadata" : "metadata",
  "trace" : [ {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  }, {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  } ],
  "purpose" : "PRODUCTION",
  "destination_node" : "destination_node",
  "file_name" : "file_name",
  "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
  "metadata_hash" : "metadata_hash",
  "project_code" : "project_code",
  "data_provider" : "data_provider",
  "id" : 0,
  "file_size" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataPackage

Up
get /backend/data-provider/{id}/
(retrieveDataProvider)
Authenticated users can list, data provider admins can update their data providers and (portal) staff can create and update any data provider.

Path parameters

id (required)
Path Parameter — default: null

Query parameters

username (optional)
Query Parameter — Only returns data providers which the user has permission to view or edit. default: null

Return type

DataProvider

Example data

Content-Type: application/json
{
  "code" : "code",
  "nodes" : [ "nodes", "nodes" ],
  "coordinators" : [ {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "name" : "name",
  "id" : 0,
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataProvider

Up
get /backend/data-transfer/{id}/
(retrieveDataTransfer)

Path parameters

id (required)
Path Parameter — default: null

Return type

DataTransfer

Example data

Content-Type: application/json
{
  "purpose" : "PRODUCTION",
  "requestor_last_name" : "requestor_last_name",
  "change_date" : "2000-01-23T04:56:07.000+00:00",
  "project" : 4,
  "project_name" : "project_name",
  "node_approvals" : [ {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  }, {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  } ],
  "requestor_display_id" : "requestor_display_id",
  "project_archived" : true,
  "permissions" : {
    "edit" : {
      "data_specification" : true,
      "purpose" : true,
      "max_packages" : true,
      "legal_basis" : true,
      "data_recipients" : true,
      "data_provider" : true,
      "requestor" : true,
      "status" : true
    },
    "delete" : true
  },
  "requestor_name" : "requestor_name",
  "data_provider" : "data_provider",
  "id" : 0,
  "requestor_full_name" : "requestor_full_name",
  "data_specification" : "https://openapi-generator.tech",
  "legal_basis" : "legal_basis",
  "data_provider_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  } ],
  "creation_date" : "2000-01-23T04:56:07.000+00:00",
  "packages" : [ {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  }, {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  } ],
  "data_provider_name" : "data_provider_name",
  "requestor" : 1,
  "requestor_email" : "requestor_email",
  "group_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  } ],
  "max_packages" : 7,
  "data_recipients" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "requestor_first_name" : "requestor_first_name",
  "status" : "INITIAL"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataTransfer

Up
get /backend/terminology/downloaded_file/{id}/
(retrieveDownloadedFile)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this downloaded file. default: null

Return type

DownloadedFile

Example data

Content-Type: application/json
{
  "created" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "user" : "user",
  "version_file" : {
    "file" : "",
    "id" : 6,
    "version" : {
      "terminology" : {
        "copyright" : "copyright",
        "code" : "code",
        "contact" : "contact",
        "documentation" : "documentation",
        "name" : "name",
        "description" : "description",
        "id" : 5,
        "confirmation_checkbox_text" : "confirmation_checkbox_text",
        "confirmation_description" : "confirmation_description"
      },
      "name" : "name",
      "id" : 1,
      "released" : "2000-01-23",
      "status" : "ACTIVE"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DownloadedFile

Up
get /backend/feed/{id}/
(retrieveFeed)

Path parameters

id (required)
Path Parameter — default: null

Return type

Feed

Example data

Content-Type: application/json
{
  "from_date" : "2000-01-23T04:56:07.000+00:00",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "label" : "INFO",
  "title" : "title",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Feed

Up
get /backend/flags/{id}/
(retrieveFlag)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this flag. default: null

Return type

Flag

Example data

Content-Type: application/json
{
  "code" : "code",
  "description" : "description",
  "id" : 0,
  "users" : [ 6, 6 ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Flag

Up
get /backend/identity/group/{id}/
(retrieveGroup)

Path parameters

id (required)
Path Parameter — default: null

Query parameters

role (optional)
Query Parameter — Includes only groups with specified role default: null
role_entity_id (optional)
Query Parameter — Includes only groups with specified role_entity_id default: null
role_entity_type (optional)
Query Parameter — Includes only groups with specified role_entity_type default: null
managed (optional)
Query Parameter — Returns only groups managed by the user default: null

Return type

Group

Example data

Content-Type: application/json
{
  "permissions_object" : [ {
    "objects" : [ 1, 1 ],
    "permission" : 5
  }, {
    "objects" : [ 1, 1 ],
    "permission" : 5
  } ],
  "permissions" : [ 1, 1 ],
  "profile" : {
    "role_entity_type" : "role_entity_type",
    "role_entity_id" : 6,
    "role" : "NA",
    "description" : "description"
  },
  "name" : "name",
  "id" : 0,
  "users" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Group

Up
get /backend/identity-provider/{id}/
(retrieveIdentityProvider)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this identity provider. default: null

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Return type

IdentityProvider

Example data

Content-Type: application/json
{
  "code" : "code",
  "name" : "name",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

IdentityProvider

Up
get /backend/nodes/{id}/
(retrieveNode)
Authenticated users can list, node admins can update their nodes and staff can create and update any node.

Path parameters

id (required)
Path Parameter — A unique integer value identifying this node. default: null

Query parameters

username (optional)
Query Parameter — Only returns nodes which the user has permission to view or edit. default: null

Return type

Node

Example data

Content-Type: application/json
{
  "code" : "code",
  "node_status" : "ON",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "ticketing_system_email" : "ticketing_system_email",
  "name" : "name",
  "oauth2_client" : 6,
  "id" : 0,
  "object_storage_url" : "https://openapi-generator.tech"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Node

Up
get /backend/oauth2-clients/{id}/
(retrieveOAuth2Client)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this OAuth2 client. default: null

Return type

OAuth2Client

Example data

Content-Type: application/json
{
  "id" : 0,
  "redirect_uri" : "redirect_uri",
  "client_name" : "client_name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OAuth2Client

Up
get /backend/identity/permission/{id}/
(retrievePermission)

Path parameters

id (required)
Path Parameter — default: null

Return type

Permission

Example data

Content-Type: application/json
{
  "content_type" : 6,
  "codename" : "codename",
  "name" : "name",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Permission

Up
get /backend/open-pgp-keys/{id}/
(retrievePgpKeyInfo)
API endpoint that displays PGP key metadata info.

Path parameters

id (required)
Path Parameter — default: null

Query parameters

fingerprint (optional)
Query Parameter — Includes only info about OpenPGP keys with specified fingerprint default: null
key_email (optional)
Query Parameter — Includes only info about OpenPGP keys verified with specified email default: null
key_user_id (optional)
Query Parameter — Includes only info about OpenPGP keys with User ID default: null
status (optional)
Query Parameter — Includes only info about OpenPGP keys in specified status default: null
username (optional)
Query Parameter — Includes only info about OpenPGP keys associated to user with specified username default: null

Return type

PgpKeyInfo

Example data

Content-Type: application/json
{
  "fingerprint" : "fingerprint",
  "id" : 0,
  "key_user_id" : "key_user_id",
  "key_email" : "key_email",
  "status" : "APPROVED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PgpKeyInfo

Up
get /backend/projects/{id}/
(retrieveProject)
Show, add, and modify projects.

Path parameters

id (required)
Path Parameter — default: null

Query parameters

search (optional)
Query Parameter — A search term. default: null
ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null
username (optional)
Query Parameter — Username for the User Role default: null
destination (optional)
Query Parameter — Includes only projects with specified destination default: null
code (optional)
Query Parameter — Includes only the project identified by specified code default: null
name (optional)
Query Parameter — Includes only the project identified by specified name default: null

Return type

Project

Example data

Content-Type: application/json
{
  "resources_support" : true,
  "gid" : 1801372,
  "code" : "code",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "user_has_role" : true,
  "destination" : "destination",
  "resources" : [ {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  }, {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  } ],
  "services_support" : true,
  "legal_approval_group" : 5,
  "legal_support_contact" : "legal_support_contact",
  "expiration_date" : "2000-01-23",
  "users" : [ {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  }, {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  } ],
  "archived" : true,
  "ssh_support" : true,
  "identity_provider" : 9,
  "additional_info" : "additional_info",
  "permissions" : {
    "edit" : {
      "resources_support" : true,
      "code" : true,
      "ip_address_ranges" : true,
      "destination" : true,
      "resources" : true,
      "services_support" : true,
      "legal_support_contact" : true,
      "legal_approval_group" : true,
      "expiration_date" : true,
      "users" : [ "USER", "USER" ],
      "ssh_support" : true,
      "identity_provider" : true,
      "additional_info" : true,
      "name" : true,
      "data_specification_approval_group" : true
    },
    "archive" : true
  },
  "name" : "name",
  "id" : 0,
  "data_specification_approval_group" : 5,
  "data_transfer_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Project

Up
get /backend/projects/{project_pk}/members/{id}/
(retrieveProjectMember)

Path parameters

project_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Return type

UserLite

Example data

Content-Type: application/json
{
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "groups" : [ "groups", "groups" ],
  "last_name" : "last_name",
  "id" : 0,
  "display_name" : "display_name",
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

UserLite

Up
get /backend/projects/{project_pk}/members/
(retrieveProjectMemberList)

Path parameters

project_pk (required)
Path Parameter — default: null

Return type

array[UserLite]

Example data

Content-Type: application/json
[ {
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "groups" : [ "groups", "groups" ],
  "last_name" : "last_name",
  "id" : 0,
  "display_name" : "display_name",
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}, {
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "groups" : [ "groups", "groups" ],
  "last_name" : "last_name",
  "id" : 0,
  "display_name" : "display_name",
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/projects/{project_pk}/members/{user_pk}/services/{id}/
(retrieveProjectMemberService)

Path parameters

project_pk (required)
Path Parameter — default: null
user_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service

Up
get /backend/projects/{project_pk}/members/{user_pk}/services/
(retrieveProjectMemberServiceList)

Path parameters

project_pk (required)
Path Parameter — default: null
user_pk (required)
Path Parameter — default: null

Return type

array[Service]

Example data

Content-Type: application/json
[ {
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}, {
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/projects/{project_pk}/services/{id}/
(retrieveProjectService)

Path parameters

project_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service

Up
get /backend/projects/{project_pk}/services/
(retrieveProjectServiceList)

Path parameters

project_pk (required)
Path Parameter — default: null

Return type

array[Service]

Example data

Content-Type: application/json
[ {
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}, {
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200


Up
get /backend/audit/project-permission/{id}/
(retrieveProjectUserRoleHistory)

Path parameters

id (required)
Path Parameter — default: null

Query parameters

from (optional)
Query Parameter — Includes only entries created after specified date default: null
to (optional)
Query Parameter — Includes only entries created before specified date default: null
project (optional)
Query Parameter — Includes only entries whose project code matches the specified regex default: null

Return type

ProjectUserRoleHistory

Example data

Content-Type: application/json
{
  "changed_by" : "changed_by",
  "project" : "project",
  "permission" : "permission",
  "user" : "user",
  "enabled" : true,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ProjectUserRoleHistory

Up
get /backend/quick-accesses/{id}/
(retrieveQuickAccessTile)

Path parameters

id (required)
Path Parameter — default: null

Return type

QuickAccessTile

Example data

Content-Type: application/json
{
  "image" : "",
  "description" : "description",
  "id" : 0,
  "title" : "title",
  "url" : "https://openapi-generator.tech",
  "order" : 6732
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

QuickAccessTile

Up
get /backend/ssh-public-keys/{id}/
(retrieveSSHPublicKey)
API endpoint for the users' SSH public keys.

Path parameters

id (required)
Path Parameter — default: null

Return type

SSHPublicKey

Example data

Content-Type: application/json
{
  "created" : "2000-01-23T04:56:07.000+00:00",
  "project" : 0,
  "id" : 6,
  "project_name" : "project_name",
  "user" : "user",
  "key" : "key",
  "changed" : "2000-01-23T04:56:07.000+00:00",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

SSHPublicKey

Up
get /backend/services/{id}/
(retrieveService)

Service endpoint.

Note that creation does NOT happen via this endpoint.

Path parameters

id (required)
Path Parameter — A unique integer value identifying this service. default: null

Query parameters

name (optional)
Query Parameter — Includes only services with specified name default: null

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service

Up
get /backend/terminology/terminology/{id}/
(retrieveTerminology)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this terminology. default: null

Return type

Terminology

Example data

Content-Type: application/json
{
  "copyright" : "copyright",
  "code" : "code",
  "versions" : [ {
    "name" : "name",
    "files" : [ {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    }, {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    } ],
    "id" : 6,
    "released" : "2000-01-23",
    "status" : "ACTIVE"
  }, {
    "name" : "name",
    "files" : [ {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    }, {
      "format" : "format",
      "id" : 1,
      "confirmation_checkbox_text" : "confirmation_checkbox_text",
      "confirmation_description" : "confirmation_description"
    } ],
    "id" : 6,
    "released" : "2000-01-23",
    "status" : "ACTIVE"
  } ],
  "contact" : "contact",
  "documentation" : "documentation",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "confirmation_checkbox_text" : "confirmation_checkbox_text",
  "confirmation_description" : "confirmation_description"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Terminology

Up
get /backend/terms-of-use/{id}/
(retrieveTermsOfUse)

Path parameters

id (required)
Path Parameter — default: null

Return type

TermsOfUse

Example data

Content-Type: application/json
{
  "node" : 6,
  "version_type" : "MINOR",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "text" : "text",
  "version" : "version",
  "users" : [ {
    "last_name" : "last_name",
    "first_name" : "first_name",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00",
    "email" : "email"
  }, {
    "last_name" : "last_name",
    "first_name" : "first_name",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00",
    "email" : "email"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

TermsOfUse

Up
get /backend/users/{id}/
(retrieveUser)
Show details of registered users.

Path parameters

id (required)
Path Parameter — default: null

Query parameters

include_inactive (optional)
Query Parameter — Includes users which are not active (is_active is False) default: null
project_id (optional)
Query Parameter — Only includes users which have at least one role in this project. default: null
role (optional)
Query Parameter — Only includes users which have at least this role in any project. default: null
first_name (optional)
Query Parameter — Includes only users with specified first name default: null
last_name (optional)
Query Parameter — Includes only users with specified last name default: null
affiliation (optional)
Query Parameter — Includes only users for whom at least one of the linked affiliations matches (or contains) the provided string default: null
username (optional)
Query Parameter — Includes only users with specified username default: null
email (optional)
Query Parameter — Returns the first user matching given email address. We first try to exactly match the official (or main) email address. As fallback we scan the provided of additional email addresses. default: null

Return type

User

Example data

Content-Type: application/json
{
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "profile" : {
    "emails" : "emails",
    "uid" : 1073290,
    "gid" : 1298106,
    "display_local_username" : "display_local_username",
    "affiliation" : "affiliation",
    "display_id" : "display_id",
    "custom_affiliation" : 5,
    "namespace" : "namespace",
    "affiliation_consent" : true,
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name"
  },
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "flags" : [ "flags", "flags" ],
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "terms_of_use" : [ {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "display_name" : "display_name",
  "id" : 0,
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

User

Up
get /backend/user-namespaces/{id}/
(retrieveUserNamespace)
View available namespaces.

Path parameters

id (required)
Path Parameter — A unique integer value identifying this user namespace. default: null

Return type

UserNamespace

Example data

Content-Type: application/json
{
  "name" : "name",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

UserNamespace

Up
get /backend/userinfo/
(retrieveUserinfo)

Return type

Userinfo

Example data

Content-Type: application/json
{
  "permissions" : {
    "has_projects" : true,
    "data_provider_viewer" : true,
    "legal_approver" : true,
    "data_manager" : true,
    "manager" : true,
    "project_leader" : true,
    "staff" : true,
    "node_admin" : true,
    "group_manager" : true,
    "data_specification_approver" : true,
    "data_provider_admin" : true,
    "node_viewer" : true
  },
  "manages" : {
    "node_admin" : [ {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 6,
      "id" : 0,
      "object_storage_url" : "https://openapi-generator.tech"
    }, {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 6,
      "id" : 0,
      "object_storage_url" : "https://openapi-generator.tech"
    } ],
    "data_provider_admin" : [ {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "coordinators" : [ {
        "uid" : 6,
        "display_local_username" : "display_local_username",
        "gid" : 1,
        "affiliation" : "affiliation",
        "roles" : "roles",
        "flags" : [ "flags", "flags" ],
        "last_name" : "last_name",
        "affiliation_id" : "affiliation_id",
        "local_username" : "local_username",
        "first_name" : "first_name",
        "email" : "email",
        "username" : "username"
      }, {
        "uid" : 6,
        "display_local_username" : "display_local_username",
        "gid" : 1,
        "affiliation" : "affiliation",
        "roles" : "roles",
        "flags" : [ "flags", "flags" ],
        "last_name" : "last_name",
        "affiliation_id" : "affiliation_id",
        "local_username" : "local_username",
        "first_name" : "first_name",
        "email" : "email",
        "username" : "username"
      } ],
      "name" : "name",
      "id" : 0,
      "enabled" : true
    }, {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "coordinators" : [ {
        "uid" : 6,
        "display_local_username" : "display_local_username",
        "gid" : 1,
        "affiliation" : "affiliation",
        "roles" : "roles",
        "flags" : [ "flags", "flags" ],
        "last_name" : "last_name",
        "affiliation_id" : "affiliation_id",
        "local_username" : "local_username",
        "first_name" : "first_name",
        "email" : "email",
        "username" : "username"
      }, {
        "uid" : 6,
        "display_local_username" : "display_local_username",
        "gid" : 1,
        "affiliation" : "affiliation",
        "roles" : "roles",
        "flags" : [ "flags", "flags" ],
        "last_name" : "last_name",
        "affiliation_id" : "affiliation_id",
        "local_username" : "local_username",
        "first_name" : "first_name",
        "email" : "email",
        "username" : "username"
      } ],
      "name" : "name",
      "id" : 0,
      "enabled" : true
    } ]
  },
  "profile" : {
    "emails" : "emails",
    "uid" : 1040041,
    "gid" : 1301372,
    "display_local_username" : "display_local_username",
    "affiliation" : "affiliation",
    "display_id" : "display_id",
    "custom_affiliation" : 1,
    "namespace" : "namespace",
    "affiliation_consent" : true,
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name"
  },
  "flags" : [ "flags", "flags" ],
  "groups" : [ "groups", "groups" ],
  "last_name" : "last_name",
  "ip_address" : "ip_address",
  "id" : 5,
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Userinfo

Up
get /backend/users/{id}/services/
(servicesUser)
Show details of registered users.

Path parameters

id (required)
Path Parameter — default: null

Return type

User

Example data

Content-Type: application/json
{
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "profile" : {
    "emails" : "emails",
    "uid" : 1073290,
    "gid" : 1298106,
    "display_local_username" : "display_local_username",
    "affiliation" : "affiliation",
    "display_id" : "display_id",
    "custom_affiliation" : 5,
    "namespace" : "namespace",
    "affiliation_consent" : true,
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name"
  },
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "flags" : [ "flags", "flags" ],
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "terms_of_use" : [ {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "display_name" : "display_name",
  "id" : 0,
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

User

Up
post /backend/open-pgp-keys/status/
(statusPgpKeyInfo)

Return the status of one or more PGP keys based on their fingerprints.

The return value is a list of object with fingerprint and status fields.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PgpKeyStatus PgpKeyStatus (optional)
Body Parameter

Return type

PgpKeyStatus

Example data

Content-Type: application/json
{
  "status_by_fingerprint" : [ {
    "fingerprint" : "fingerprint",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "status" : "APPROVED"
  } ],
  "fingerprints" : [ "fingerprints", "fingerprints" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

PgpKeyStatus

Up
put /backend/projects/{id}/unarchive/
(unarchiveProject)
Show, add, and modify projects.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Project Project (optional)
Body Parameter

Return type

Project

Example data

Content-Type: application/json
{
  "resources_support" : true,
  "gid" : 1801372,
  "code" : "code",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "user_has_role" : true,
  "destination" : "destination",
  "resources" : [ {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  }, {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  } ],
  "services_support" : true,
  "legal_approval_group" : 5,
  "legal_support_contact" : "legal_support_contact",
  "expiration_date" : "2000-01-23",
  "users" : [ {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  }, {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  } ],
  "archived" : true,
  "ssh_support" : true,
  "identity_provider" : 9,
  "additional_info" : "additional_info",
  "permissions" : {
    "edit" : {
      "resources_support" : true,
      "code" : true,
      "ip_address_ranges" : true,
      "destination" : true,
      "resources" : true,
      "services_support" : true,
      "legal_support_contact" : true,
      "legal_approval_group" : true,
      "expiration_date" : true,
      "users" : [ "USER", "USER" ],
      "ssh_support" : true,
      "identity_provider" : true,
      "additional_info" : true,
      "name" : true,
      "data_specification_approval_group" : true
    },
    "archive" : true
  },
  "name" : "name",
  "id" : 0,
  "data_specification_approval_group" : 5,
  "data_transfer_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Project

Up
post /backend/data-provider/unique/
(uniqueDataProvider)
Authenticated users can list, data provider admins can update their data providers and (portal) staff can create and update any data provider.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UniqueDataProvider UniqueDataProvider (optional)
Body Parameter

Responses

200

is unique

409

is NOT unique

Up
post /backend/flags/unique/
(uniqueFlag)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UniqueFlag UniqueFlag (optional)
Body Parameter

Responses

200

is unique

409

is NOT unique

Up
post /backend/identity/group/unique/
(uniqueGroup)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UniqueGroup UniqueGroup (optional)
Body Parameter

Responses

200

is unique

409

is NOT unique

Up
post /backend/nodes/unique/
(uniqueNode)
Authenticated users can list, node admins can update their nodes and staff can create and update any node.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UniqueNode UniqueNode (optional)
Body Parameter

Responses

200

is unique

409

is NOT unique

Up
post /backend/open-pgp-keys/unique/
(uniquePgpKeyInfo)
API endpoint that displays PGP key metadata info.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UniquePgpKeyInfo UniquePgpKeyInfo (optional)
Body Parameter

Responses

200

is unique

409

is NOT unique

Up
post /backend/projects/unique/
(uniqueProject)
Show, add, and modify projects.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UniqueProject UniqueProject (optional)
Body Parameter

Responses

200

is unique

409

is NOT unique

Up
post /backend/users/unique/
(uniqueUser)
Show details of registered users.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UniqueUser UniqueUser (optional)
Body Parameter

Responses

200

is unique

409

is NOT unique

Up
put /backend/approval/{id}/
(updateApproval)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Approval Approval (optional)
Body Parameter

Return type

DataTransfer

Example data

Content-Type: application/json
{
  "purpose" : "PRODUCTION",
  "requestor_last_name" : "requestor_last_name",
  "change_date" : "2000-01-23T04:56:07.000+00:00",
  "project" : 4,
  "project_name" : "project_name",
  "node_approvals" : [ {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  }, {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  } ],
  "requestor_display_id" : "requestor_display_id",
  "project_archived" : true,
  "permissions" : {
    "edit" : {
      "data_specification" : true,
      "purpose" : true,
      "max_packages" : true,
      "legal_basis" : true,
      "data_recipients" : true,
      "data_provider" : true,
      "requestor" : true,
      "status" : true
    },
    "delete" : true
  },
  "requestor_name" : "requestor_name",
  "data_provider" : "data_provider",
  "id" : 0,
  "requestor_full_name" : "requestor_full_name",
  "data_specification" : "https://openapi-generator.tech",
  "legal_basis" : "legal_basis",
  "data_provider_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  } ],
  "creation_date" : "2000-01-23T04:56:07.000+00:00",
  "packages" : [ {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  }, {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  } ],
  "data_provider_name" : "data_provider_name",
  "requestor" : 1,
  "requestor_email" : "requestor_email",
  "group_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  } ],
  "max_packages" : 7,
  "data_recipients" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "requestor_first_name" : "requestor_first_name",
  "status" : "INITIAL"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataTransfer

Up
put /backend/data-package/{id}/
(updateDataPackage)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataPackage DataPackage (optional)
Body Parameter

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Return type

DataPackage

Example data

Content-Type: application/json
{
  "data_transfer" : "data_transfer",
  "metadata" : "metadata",
  "trace" : [ {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  }, {
    "node" : "node",
    "timestamp" : "2000-01-23T04:56:07.000+00:00",
    "status" : "ENTER"
  } ],
  "purpose" : "PRODUCTION",
  "destination_node" : "destination_node",
  "file_name" : "file_name",
  "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
  "metadata_hash" : "metadata_hash",
  "project_code" : "project_code",
  "data_provider" : "data_provider",
  "id" : 0,
  "file_size" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataPackage

Up
put /backend/data-provider/{id}/
(updateDataProvider)
Authenticated users can list, data provider admins can update their data providers and (portal) staff can create and update any data provider.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataProvider DataProvider (optional)
Body Parameter

Query parameters

username (optional)
Query Parameter — Only returns data providers which the user has permission to view or edit. default: null

Return type

DataProvider

Example data

Content-Type: application/json
{
  "code" : "code",
  "nodes" : [ "nodes", "nodes" ],
  "coordinators" : [ {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "uid" : 6,
    "display_local_username" : "display_local_username",
    "gid" : 1,
    "affiliation" : "affiliation",
    "roles" : "roles",
    "flags" : [ "flags", "flags" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "name" : "name",
  "id" : 0,
  "enabled" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataProvider

Up
put /backend/data-transfer/{id}/
(updateDataTransfer)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DataTransfer DataTransfer (optional)
Body Parameter

Return type

DataTransfer

Example data

Content-Type: application/json
{
  "purpose" : "PRODUCTION",
  "requestor_last_name" : "requestor_last_name",
  "change_date" : "2000-01-23T04:56:07.000+00:00",
  "project" : 4,
  "project_name" : "project_name",
  "node_approvals" : [ {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  }, {
    "node" : {
      "code" : "code",
      "node_status" : "ON",
      "ip_address_ranges" : [ {
        "ip_address" : "ip_address",
        "mask" : 4
      }, {
        "ip_address" : "ip_address",
        "mask" : 4
      } ],
      "ticketing_system_email" : "ticketing_system_email",
      "name" : "name",
      "oauth2_client" : 2,
      "id" : 5,
      "object_storage_url" : "https://openapi-generator.tech"
    },
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 5,
    "type" : "H",
    "status" : "A"
  } ],
  "requestor_display_id" : "requestor_display_id",
  "project_archived" : true,
  "permissions" : {
    "edit" : {
      "data_specification" : true,
      "purpose" : true,
      "max_packages" : true,
      "legal_basis" : true,
      "data_recipients" : true,
      "data_provider" : true,
      "requestor" : true,
      "status" : true
    },
    "delete" : true
  },
  "requestor_name" : "requestor_name",
  "data_provider" : "data_provider",
  "id" : 0,
  "requestor_full_name" : "requestor_full_name",
  "data_specification" : "https://openapi-generator.tech",
  "legal_basis" : "legal_basis",
  "data_provider_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "data_provider" : {
      "code" : "code",
      "nodes" : [ "nodes", "nodes" ],
      "name" : "name",
      "id" : 9,
      "enabled" : true
    },
    "id" : 7,
    "status" : "A"
  } ],
  "creation_date" : "2000-01-23T04:56:07.000+00:00",
  "packages" : [ {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  }, {
    "data_transfer" : "data_transfer",
    "metadata" : "metadata",
    "trace" : [ {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    }, {
      "node" : "node",
      "timestamp" : "2000-01-23T04:56:07.000+00:00",
      "status" : "ENTER"
    } ],
    "purpose" : "PRODUCTION",
    "destination_node" : "destination_node",
    "file_name" : "file_name",
    "sender_open_pgp_key_info" : "sender_open_pgp_key_info",
    "metadata_hash" : "metadata_hash",
    "project_code" : "project_code",
    "data_provider" : "data_provider",
    "id" : 6,
    "file_size" : 1
  } ],
  "data_provider_name" : "data_provider_name",
  "requestor" : 1,
  "requestor_email" : "requestor_email",
  "group_approvals" : [ {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  }, {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "change_date" : "2000-01-23T04:56:07.000+00:00",
    "can_approve" : true,
    "rejection_reason" : "rejection_reason",
    "id" : 3,
    "status" : "A",
    "group" : {
      "profile" : {
        "role_entity_type" : "role_entity_type",
        "role_entity_id" : 2,
        "role" : "NA",
        "description" : "description"
      },
      "name" : "name"
    }
  } ],
  "max_packages" : 7,
  "data_recipients" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ],
  "requestor_first_name" : "requestor_first_name",
  "status" : "INITIAL"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

DataTransfer

Up
put /backend/feed/{id}/
(updateFeed)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Feed Feed (optional)
Body Parameter

Return type

Feed

Example data

Content-Type: application/json
{
  "from_date" : "2000-01-23T04:56:07.000+00:00",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "label" : "INFO",
  "title" : "title",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Feed

Up
put /backend/flags/{id}/
(updateFlag)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this flag. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Flag Flag (optional)
Body Parameter

Return type

Flag

Example data

Content-Type: application/json
{
  "code" : "code",
  "description" : "description",
  "id" : 0,
  "users" : [ 6, 6 ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Flag

Up
put /backend/identity/group/{id}/
(updateGroup)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Group Group (optional)
Body Parameter

Query parameters

role (optional)
Query Parameter — Includes only groups with specified role default: null
role_entity_id (optional)
Query Parameter — Includes only groups with specified role_entity_id default: null
role_entity_type (optional)
Query Parameter — Includes only groups with specified role_entity_type default: null
managed (optional)
Query Parameter — Returns only groups managed by the user default: null

Return type

Group

Example data

Content-Type: application/json
{
  "permissions_object" : [ {
    "objects" : [ 1, 1 ],
    "permission" : 5
  }, {
    "objects" : [ 1, 1 ],
    "permission" : 5
  } ],
  "permissions" : [ 1, 1 ],
  "profile" : {
    "role_entity_type" : "role_entity_type",
    "role_entity_id" : 6,
    "role" : "NA",
    "description" : "description"
  },
  "name" : "name",
  "id" : 0,
  "users" : [ {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  }, {
    "last_name" : "last_name",
    "id" : 1,
    "display_name" : "display_name",
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Group

Up
put /backend/identity-provider/{id}/
(updateIdentityProvider)

Path parameters

id (required)
Path Parameter — A unique integer value identifying this identity provider. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

IdentityProvider IdentityProvider (optional)
Body Parameter

Query parameters

ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null

Return type

IdentityProvider

Example data

Content-Type: application/json
{
  "code" : "code",
  "name" : "name",
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

IdentityProvider

Up
put /backend/nodes/{id}/
(updateNode)
Authenticated users can list, node admins can update their nodes and staff can create and update any node.

Path parameters

id (required)
Path Parameter — A unique integer value identifying this node. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Node Node (optional)
Body Parameter

Query parameters

username (optional)
Query Parameter — Only returns nodes which the user has permission to view or edit. default: null

Return type

Node

Example data

Content-Type: application/json
{
  "code" : "code",
  "node_status" : "ON",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "ticketing_system_email" : "ticketing_system_email",
  "name" : "name",
  "oauth2_client" : 6,
  "id" : 0,
  "object_storage_url" : "https://openapi-generator.tech"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Node

Up
put /backend/open-pgp-keys/{id}/
(updatePgpKeyInfo)
API endpoint that displays PGP key metadata info.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PgpKeyInfo PgpKeyInfo (optional)
Body Parameter

Query parameters

fingerprint (optional)
Query Parameter — Includes only info about OpenPGP keys with specified fingerprint default: null
key_email (optional)
Query Parameter — Includes only info about OpenPGP keys verified with specified email default: null
key_user_id (optional)
Query Parameter — Includes only info about OpenPGP keys with User ID default: null
status (optional)
Query Parameter — Includes only info about OpenPGP keys in specified status default: null
username (optional)
Query Parameter — Includes only info about OpenPGP keys associated to user with specified username default: null

Return type

PgpKeyInfo

Example data

Content-Type: application/json
{
  "fingerprint" : "fingerprint",
  "id" : 0,
  "key_user_id" : "key_user_id",
  "key_email" : "key_email",
  "status" : "APPROVED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

PgpKeyInfo

Up
put /backend/projects/{id}/
(updateProject)
Show, add, and modify projects.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Project Project (optional)
Body Parameter

Query parameters

search (optional)
Query Parameter — A search term. default: null
ordering (optional)
Query Parameter — Which field to use when ordering the results. default: null
username (optional)
Query Parameter — Username for the User Role default: null
destination (optional)
Query Parameter — Includes only projects with specified destination default: null
code (optional)
Query Parameter — Includes only the project identified by specified code default: null
name (optional)
Query Parameter — Includes only the project identified by specified name default: null

Return type

Project

Example data

Content-Type: application/json
{
  "resources_support" : true,
  "gid" : 1801372,
  "code" : "code",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "user_has_role" : true,
  "destination" : "destination",
  "resources" : [ {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  }, {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  } ],
  "services_support" : true,
  "legal_approval_group" : 5,
  "legal_support_contact" : "legal_support_contact",
  "expiration_date" : "2000-01-23",
  "users" : [ {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  }, {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  } ],
  "archived" : true,
  "ssh_support" : true,
  "identity_provider" : 9,
  "additional_info" : "additional_info",
  "permissions" : {
    "edit" : {
      "resources_support" : true,
      "code" : true,
      "ip_address_ranges" : true,
      "destination" : true,
      "resources" : true,
      "services_support" : true,
      "legal_support_contact" : true,
      "legal_approval_group" : true,
      "expiration_date" : true,
      "users" : [ "USER", "USER" ],
      "ssh_support" : true,
      "identity_provider" : true,
      "additional_info" : true,
      "name" : true,
      "data_specification_approval_group" : true
    },
    "archive" : true
  },
  "name" : "name",
  "id" : 0,
  "data_specification_approval_group" : 5,
  "data_transfer_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Project

Up
put /backend/projects/{project_pk}/members/{id}/
(updateProjectMember)

Path parameters

project_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

UserLite UserLite (optional)
Body Parameter

Return type

UserLite

Example data

Content-Type: application/json
{
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "groups" : [ "groups", "groups" ],
  "last_name" : "last_name",
  "id" : 0,
  "display_name" : "display_name",
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

UserLite

Up
put /backend/projects/{project_pk}/members/{user_pk}/services/{id}/
(updateProjectMemberService)

Path parameters

project_pk (required)
Path Parameter — default: null
user_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Service Service (optional)
Body Parameter

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service

Up
put /backend/projects/{project_pk}/services/{id}/
(updateProjectService)

Path parameters

project_pk (required)
Path Parameter — default: null
id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Service Service (optional)
Body Parameter

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service

Up
put /backend/quick-accesses/{id}/
(updateQuickAccessTile)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

QuickAccessTile QuickAccessTile (optional)
Body Parameter

Return type

QuickAccessTile

Example data

Content-Type: application/json
{
  "image" : "",
  "description" : "description",
  "id" : 0,
  "title" : "title",
  "url" : "https://openapi-generator.tech",
  "order" : 6732
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

QuickAccessTile

Up
put /backend/ssh-public-keys/{id}/
(updateSSHPublicKey)
API endpoint for the users' SSH public keys.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SSHPublicKey SSHPublicKey (optional)
Body Parameter

Return type

SSHPublicKey

Example data

Content-Type: application/json
{
  "created" : "2000-01-23T04:56:07.000+00:00",
  "project" : 0,
  "id" : 6,
  "project_name" : "project_name",
  "user" : "user",
  "key" : "key",
  "changed" : "2000-01-23T04:56:07.000+00:00",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

SSHPublicKey

Up
put /backend/services/{id}/
(updateService)

Service endpoint.

Note that creation does NOT happen via this endpoint.

Path parameters

id (required)
Path Parameter — A unique integer value identifying this service. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Service Service (optional)
Body Parameter

Query parameters

name (optional)
Query Parameter — Includes only services with specified name default: null

Return type

Service

Example data

Content-Type: application/json
{
  "data" : "data",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "description" : "description",
  "archived" : "2000-01-23T04:56:07.000+00:00",
  "user_id" : "user_id",
  "project_id" : "project_id",
  "name" : "name",
  "action" : "NONE",
  "id" : 0,
  "state" : "INITIAL",
  "action_timestamp" : "2000-01-23T04:56:07.000+00:00",
  "locked" : "2000-01-23T04:56:07.000+00:00",
  "changed" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service

Up
put /backend/switch-notification/
(updateSwitchNotification)

Allows switch notification API to push changes to user's affiliation to portal.

See https://www.switch.ch/edu-id/docs/services/sp-notification/ for the implementation details.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AnyType (optional)
Body Parameter

Return type

oas_any_type_not_mapped

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

oas_any_type_not_mapped

Up
put /backend/terms-of-use/{id}/
(updateTermsOfUse)

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TermsOfUse TermsOfUse (optional)
Body Parameter

Return type

TermsOfUse

Example data

Content-Type: application/json
{
  "node" : 6,
  "version_type" : "MINOR",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "id" : 0,
  "text" : "text",
  "version" : "version",
  "users" : [ {
    "last_name" : "last_name",
    "first_name" : "first_name",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00",
    "email" : "email"
  }, {
    "last_name" : "last_name",
    "first_name" : "first_name",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00",
    "email" : "email"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

TermsOfUse

Up
put /backend/users/{id}/
(updateUser)
Show details of registered users.

Path parameters

id (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

User User (optional)
Body Parameter

Query parameters

include_inactive (optional)
Query Parameter — Includes users which are not active (is_active is False) default: null
project_id (optional)
Query Parameter — Only includes users which have at least one role in this project. default: null
role (optional)
Query Parameter — Only includes users which have at least this role in any project. default: null
first_name (optional)
Query Parameter — Includes only users with specified first name default: null
last_name (optional)
Query Parameter — Includes only users with specified last name default: null
affiliation (optional)
Query Parameter — Includes only users for whom at least one of the linked affiliations matches (or contains) the provided string default: null
username (optional)
Query Parameter — Includes only users with specified username default: null
email (optional)
Query Parameter — Returns the first user matching given email address. We first try to exactly match the official (or main) email address. As fallback we scan the provided of additional email addresses. default: null

Return type

User

Example data

Content-Type: application/json
{
  "is_active" : true,
  "last_login" : "2000-01-23T04:56:07.000+00:00",
  "profile" : {
    "emails" : "emails",
    "uid" : 1073290,
    "gid" : 1298106,
    "display_local_username" : "display_local_username",
    "affiliation" : "affiliation",
    "display_id" : "display_id",
    "custom_affiliation" : 5,
    "namespace" : "namespace",
    "affiliation_consent" : true,
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name"
  },
  "open_pgp_keys" : [ {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  }, {
    "fingerprint" : "fingerprint",
    "id" : 6,
    "key_user_id" : "key_user_id",
    "key_email" : "key_email",
    "status" : "APPROVED"
  } ],
  "flags" : [ "flags", "flags" ],
  "last_name" : "last_name",
  "groups" : [ "groups", "groups" ],
  "terms_of_use" : [ {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "node" : "node",
    "id" : 6,
    "version" : "version",
    "accepted_at" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "display_name" : "display_name",
  "id" : 0,
  "first_name" : "first_name",
  "email" : "email",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

User

Up
get /backend/projects/{id}/users/
(usersProject)

List users of a given project by permission.

GET params:

Path parameters

id (required)
Path Parameter — default: null

Return type

Project

Example data

Content-Type: application/json
{
  "resources_support" : true,
  "gid" : 1801372,
  "code" : "code",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "ip_address_ranges" : [ {
    "ip_address" : "ip_address",
    "mask" : 4
  }, {
    "ip_address" : "ip_address",
    "mask" : 4
  } ],
  "user_has_role" : true,
  "destination" : "destination",
  "resources" : [ {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  }, {
    "contact" : "contact",
    "name" : "name",
    "description" : "description",
    "location" : "https://openapi-generator.tech",
    "id" : 2
  } ],
  "services_support" : true,
  "legal_approval_group" : 5,
  "legal_support_contact" : "legal_support_contact",
  "expiration_date" : "2000-01-23",
  "users" : [ {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  }, {
    "gid" : "gid",
    "custom_affiliation" : "custom_affiliation",
    "roles" : [ "USER", "USER" ],
    "last_name" : "last_name",
    "affiliation_id" : "affiliation_id",
    "local_username" : "local_username",
    "display_name" : "display_name",
    "uid" : "uid",
    "affiliation" : "affiliation",
    "authorized" : true,
    "id" : 7,
    "first_name" : "first_name",
    "email" : "email",
    "username" : "username",
    "terms_of_use_accepted" : "terms_of_use_accepted"
  } ],
  "archived" : true,
  "ssh_support" : true,
  "identity_provider" : 9,
  "additional_info" : "additional_info",
  "permissions" : {
    "edit" : {
      "resources_support" : true,
      "code" : true,
      "ip_address_ranges" : true,
      "destination" : true,
      "resources" : true,
      "services_support" : true,
      "legal_support_contact" : true,
      "legal_approval_group" : true,
      "expiration_date" : true,
      "users" : [ "USER", "USER" ],
      "ssh_support" : true,
      "identity_provider" : true,
      "additional_info" : true,
      "name" : true,
      "data_specification_approval_group" : true
    },
    "archive" : true
  },
  "name" : "name",
  "id" : 0,
  "data_specification_approval_group" : 5,
  "data_transfer_count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Project

Models

[ Jump to Methods ]

Table of Contents

  1. AnyObject -
  2. Approval -
  3. Contact -
  4. Credentials -
  5. CustomAffiliation -
  6. DataPackage -
  7. DataPackageCheck -
  8. DataPackageLog -
  9. DataPackage_trace_inner -
  10. DataProvider -
  11. DataProvider_coordinators_inner -
  12. DataTransfer -
  13. DataTransferLite -
  14. DataTransferLite_packages_inner -
  15. DataTransfer_data_provider_approvals_inner -
  16. DataTransfer_data_provider_approvals_inner_data_provider -
  17. DataTransfer_data_recipients_inner -
  18. DataTransfer_group_approvals_inner -
  19. DataTransfer_group_approvals_inner_group -
  20. DataTransfer_group_approvals_inner_group_profile -
  21. DataTransfer_node_approvals_inner -
  22. DataTransfer_node_approvals_inner_node -
  23. DataTransfer_packages_inner -
  24. DataTransfer_permissions -
  25. DataTransfer_permissions_edit -
  26. DownloadedFile -
  27. DownloadedFile_version_file -
  28. DownloadedFile_version_file_version -
  29. DownloadedFile_version_file_version_terminology -
  30. Feed -
  31. Flag -
  32. Group -
  33. Group_permissions_object_inner -
  34. Group_profile -
  35. IdentityProvider -
  36. Node -
  37. Node_ip_address_ranges_inner -
  38. OAuth2Client -
  39. Permission -
  40. PgpKeyInfo -
  41. PgpKeyMetadata -
  42. PgpKeyStatus -
  43. PgpKeyStatus_status_by_fingerprint_inner -
  44. Project -
  45. ProjectUserRoleHistory -
  46. Project_permissions -
  47. Project_permissions_edit -
  48. Project_resources_inner -
  49. Project_users_inner -
  50. QuickAccessTile -
  51. SSHPublicKey -
  52. Service -
  53. Terminology -
  54. Terminology_versions_inner -
  55. Terminology_versions_inner_files_inner -
  56. TermsOfUse -
  57. TermsOfUseAcceptance -
  58. TermsOfUseLite -
  59. TermsOfUse_users_inner -
  60. UniqueDataProvider -
  61. UniqueFlag -
  62. UniqueGroup -
  63. UniqueNode -
  64. UniquePgpKeyInfo -
  65. UniqueProject -
  66. UniqueUser -
  67. User -
  68. UserLite -
  69. UserLite_open_pgp_keys_inner -
  70. UserNamespace -
  71. User_profile -
  72. User_terms_of_use_inner -
  73. Userinfo -
  74. Userinfo_manages -
  75. Userinfo_permissions -
  76. Userinfo_profile -
  77. VersionFileDownload -

AnyObject - Up

id (optional)
name (optional)

Approval - Up

id (optional)
Integer Approval ID in institution approval table
institution
String Institution (either data provider or node)
Enum:
node
data_provider
group
status
String Approval status
Enum:
A
R
W
B
existing_legal_basis (optional)
Boolean Confirmation that a legal basis exists for the data transfer
technical_measures_in_place (optional)
Boolean Confirmation that all technical measures are in place
project_space_ready (optional)
Boolean Confirmation that project space is ready. Applies to hosting node only.
data_delivery_approved (optional)
Boolean Confirmation that the data delivery has been approved
rejection_reason (optional)
String Reason for rejecting the approval

Contact - Up

first_name (optional)
last_name (optional)
email (optional)
String format: email
subject
message
send_copy

Credentials - Up

endpoint (optional)
String Storage Endpoint
bucket (optional)
String Bucket
access_key_id (optional)
String Access key ID
secret_access_key (optional)
String Secret access key
session_token (optional)
String Session token
expiration (optional)
Date Expiration date time format: date-time
dtr (optional)
Integer Data Transfer ID
file_name (optional)
String Name of the data package
action
Enum:
read
write

CustomAffiliation - Up

id (optional)
code (optional)
String Code for the non-Switch organisation a user is associated with.
name (optional)
String Name of the non-Switch organisation a user is associated with.

DataPackage - Up

metadata_hash (optional)
data_transfer (optional)
purpose (optional)
Enum:
PRODUCTION
TEST
project_code (optional)
file_name
metadata
id (optional)
trace (optional)
destination_node (optional)
data_provider (optional)
file_size (optional)
sender_open_pgp_key_info (optional)

DataPackageCheck - Up

metadata_hash (optional)
data_transfer (optional)
purpose (optional)
Enum:
PRODUCTION
TEST
project_code (optional)
file_name
metadata

DataPackageLog - Up

id (optional)
data_package (optional)
timestamp (optional)
Date format: date-time
node
status
Enum:
ENTER
PROCESSED
DELETED
ERROR
file_name
metadata
file_size
Integer File size in bytes (min. 1b)

DataPackage_trace_inner - Up

node
timestamp (optional)
Date format: date-time
status
Enum:
ENTER
PROCESSED
DELETED
ERROR

DataProvider - Up

id (optional)
code
name
enabled (optional)
nodes
coordinators (optional)
array[DataProvider_coordinators_inner] Users who are allowed to change data transfer approval status.

DataProvider_coordinators_inner - Up

username (optional)
String Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
email (optional)
String format: email
last_name (optional)
first_name (optional)
local_username (optional)
affiliation (optional)
affiliation_id (optional)
display_local_username (optional)
uid (optional)
gid (optional)
flags (optional)
roles (optional)

DataTransfer - Up

id (optional)
packages (optional)
node_approvals (optional)
data_provider_approvals (optional)
data_provider_name (optional)
group_approvals (optional)
requestor_name (optional)
requestor_display_id (optional)
requestor_first_name (optional)
requestor_full_name (optional)
requestor_last_name (optional)
requestor_email (optional)
project_name (optional)
project_archived (optional)
permissions (optional)
project
max_packages
status (optional)
Enum:
INITIAL
AUTHORIZED
UNAUTHORIZED
EXPIRED
data_provider
requestor (optional)
purpose
Enum:
PRODUCTION
TEST
legal_basis (optional)
String A reference to the legal basis document for the data transfer
creation_date (optional)
Date format: date-time
change_date (optional)
Date format: date-time
data_specification (optional)
URI format: uri
data_recipients (optional)
array[DataTransfer_data_recipients_inner] Data recipients associated with this data transfer

DataTransferLite - Up

id (optional)
change_date (optional)
Date format: date-time
data_provider_name (optional)
max_packages (optional)
packages (optional)
project (optional)
project_name (optional)
purpose (optional)
Enum:
PRODUCTION
TEST
requestor_full_name (optional)
status (optional)
Enum:
INITIAL
AUTHORIZED
UNAUTHORIZED
EXPIRED
data_provider_code (optional)

DataTransferLite_packages_inner - Up

file_name (optional)

DataTransfer_data_provider_approvals_inner - Up

id (optional)
status (optional)
String Current status of this Approval
Enum:
A
R
W
B
can_approve (optional)
Boolean Whether current user is allowed to change approval's status
rejection_reason (optional)
String Reason for rejecting this Approval
data_provider (optional)
created (optional)
Date format: date-time
change_date (optional)
Date format: date-time

DataTransfer_data_provider_approvals_inner_data_provider - Up

id (optional)
code
name
enabled (optional)
nodes

DataTransfer_data_recipients_inner - Up

username (optional)
String Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
email (optional)
String format: email
last_name (optional)
first_name (optional)
display_name (optional)
String User's display name
id
Integer User's technical unique identifier

DataTransfer_group_approvals_inner - Up

id (optional)
status (optional)
String Current status of this Approval
Enum:
A
R
W
B
can_approve (optional)
Boolean Whether current user is allowed to change approval's status
rejection_reason (optional)
String Reason for rejecting this Approval
group (optional)
created (optional)
Date format: date-time
change_date (optional)
Date format: date-time

DataTransfer_group_approvals_inner_group - Up

name
profile

DataTransfer_group_approvals_inner_group_profile - Up

role_entity_type (optional)
role_entity_id (optional)
description (optional)
String Group description
role (optional)
Enum:
NA
NV
NM
DPTA
DPW
DPC
DPDE
DPSO
DPM
ELSI
FAIR

DataTransfer_node_approvals_inner - Up

id (optional)
status (optional)
String Current status of this Approval
Enum:
A
R
W
B
can_approve (optional)
Boolean Whether current user is allowed to change approval's status
rejection_reason (optional)
String Reason for rejecting this Approval
node (optional)
type (optional)
String Either hosting or transfer node
Enum:
H
T
created (optional)
Date format: date-time
change_date (optional)
Date format: date-time

DataTransfer_node_approvals_inner_node - Up

id (optional)
code
name
node_status
Enum:
ON
OFF
ticketing_system_email
String format: email
object_storage_url (optional)
URI S3 repository URL format: uri
oauth2_client (optional)
Integer OAuth2 client used by the S3 repository
ip_address_ranges (optional)

DataTransfer_packages_inner - Up

metadata_hash (optional)
data_transfer (optional)
purpose (optional)
Enum:
PRODUCTION
TEST
project_code (optional)
file_name
metadata
id (optional)
trace (optional)
destination_node (optional)
data_provider (optional)
file_size (optional)
sender_open_pgp_key_info (optional)

DataTransfer_permissions - Up

Permissions the requestor has over this data transfer object.
edit (optional)
delete (optional)

DataTransfer_permissions_edit - Up

max_packages (optional)
data_provider (optional)
purpose (optional)
status (optional)
requestor (optional)
legal_basis (optional)
data_specification (optional)
data_recipients (optional)

DownloadedFile - Up

id (optional)
created (optional)
Date format: date-time
user
version_file (optional)

DownloadedFile_version_file - Up

id (optional)
file
File Versioned and terminology specific file to download. Must be defined. If the file already exists, then it will get overwritten. format: binary
version (optional)

DownloadedFile_version_file_version - Up

id (optional)
name
String Version name. Must be defined.
released (optional)
date Date at which a given terminology file has been released. Must be defined. format: date
status (optional)
Enum:
ACTIVE
ARCHIVED
terminology (optional)

DownloadedFile_version_file_version_terminology - Up

id (optional)
code
String Terminology code and unique identifier. Must be defined.
name
String Terminology name. Must be defined.
contact
String Contact person and/or organization. Must be defined.
description
String Longer description of a terminology. Must be defined.
copyright (optional)
String Copyright notice when using a specific terminology.
documentation (optional)
String Further information/documentation on a given terminology.
confirmation_checkbox_text (optional)
String Text to show next to the checkbox the user needs to tick before being able to download the file. If left empty, it will NOT show a dialog when the user attempts to download a file.
confirmation_description (optional)
String Additional text to show below the checkbox the user needs to tick before being able to download the file. If you specify text here, you MUST also specify text for the checkbox.

Feed - Up

created (optional)
Date format: date-time
label
Enum:
INFO
WARN
title (optional)
message (optional)
from_date (optional)
Date format: date-time

Flag - Up

id (optional)
code
description (optional)
users (optional)

Group - Up

id (optional)
name
profile (optional)
users
array[DataTransfer_data_recipients_inner] Users associated with this group
permissions (optional)
permissions_object (optional)

Group_permissions_object_inner - Up

permission
objects

Group_profile - Up

Contains more attributes about the group
role_entity_type (optional)
role_entity_id (optional)
description (optional)
String Group description
role (optional)
Enum:
NA
NV
NM
DPTA
DPW
DPC
DPDE
DPSO
DPM
ELSI
FAIR

IdentityProvider - Up

id (optional)
code (optional)
String Unique code for the identity provider
name (optional)
String Descriptive name of the identity provider

Node - Up

id (optional)
code
name
node_status
Enum:
ON
OFF
ticketing_system_email
String format: email
object_storage_url (optional)
URI S3 repository URL format: uri
oauth2_client (optional)
Integer OAuth2 client used by the S3 repository
ip_address_ranges (optional)

Node_ip_address_ranges_inner - Up

ip_address
mask

OAuth2Client - Up

id (optional)
client_name (optional)
String Helps to uniquely identify the client by name in the list of all clients. It is NOT an unique identifier.
redirect_uri (optional)
String Redirection URI for use in redirect-based flows such as the authorization code and implicitflows (typically 'http://localhost:9001/oauth_callback' using a minio local instance).

Permission - Up

id (optional)
name
codename
content_type

PgpKeyInfo - Up

fingerprint
status (optional)
Enum:
APPROVED
APPROVAL_REVOKED
DELETED
KEY_REVOKED
PENDING
REJECTED
id (optional)
key_user_id (optional)
key_email (optional)
String format: email

PgpKeyMetadata - Up

fingerprint
user_id (optional)
email (optional)
status (optional)
Enum:
EXPIRED
INVALID
NONVERIFIED
REVOKED
VERIFIED
status_info (optional)
error (optional)

PgpKeyStatus - Up

fingerprints
status_by_fingerprint (optional)

PgpKeyStatus_status_by_fingerprint_inner - Up

fingerprint (optional)
status (optional)
Enum:
APPROVED
APPROVAL_REVOKED
DELETED
KEY_REVOKED
PENDING
REJECTED

Project - Up

id (optional)
created (optional)
Date format: date-time
gid (optional)
permissions (optional)
data_transfer_count (optional)
Integer The number of data transfers associated with the project
archived (optional)
user_has_role (optional)
Boolean Whether the current user has at least one role in the project
name
code
data_specification_approval_group (optional)
legal_approval_group (optional)
destination (optional)
legal_support_contact (optional)
String format: email
expiration_date (optional)
date format: date
ip_address_ranges (optional)
resources (optional)
users (optional)
ssh_support (optional)
resources_support (optional)
services_support (optional)
identity_provider (optional)
additional_info (optional)
String Additional project information in markdown

ProjectUserRoleHistory - Up

timestamp
Date format: date-time
changed_by
user
project
permission
enabled

Project_permissions - Up

edit (optional)
archive (optional)

Project_permissions_edit - Up

name (optional)
code (optional)
destination (optional)
users (optional)
Enum:
ip_address_ranges (optional)
resources (optional)
legal_support_contact (optional)
legal_approval_group (optional)
expiration_date (optional)
ssh_support (optional)
resources_support (optional)
services_support (optional)
identity_provider (optional)
data_specification_approval_group (optional)
additional_info (optional)

Project_resources_inner - Up

id (optional)
name
location
URI format: uri
description (optional)
contact (optional)
String format: email

Project_users_inner - Up

username (optional)
String Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
local_username (optional)
email (optional)
String format: email
first_name (optional)
last_name (optional)
display_name (optional)
uid (optional)
gid (optional)
affiliation (optional)
affiliation_id (optional)
custom_affiliation (optional)
authorized (optional)
terms_of_use_accepted (optional)
id (optional)
roles
Enum:

QuickAccessTile - Up

id (optional)
title
description (optional)
url
URI format: uri
image
File format: binary
order (optional)
Integer The order of this quick access tile (for sorting).

SSHPublicKey - Up

project
created (optional)
Date format: date-time
changed (optional)
Date format: date-time
key
id (optional)
username (optional)
project_name (optional)
user (optional)

Service - Up

id (optional)
user_id (optional)
project_id (optional)
name
description (optional)
data (optional)
action (optional)
Enum:
NONE
CREATE
LOCK
ARCHIVE
action_timestamp (optional)
Date format: date-time
state (optional)
Enum:
INITIAL
PROGRESS
CREATED
LOCKED
ARCHIVED
created (optional)
Date format: date-time
changed (optional)
Date format: date-time
locked (optional)
Date format: date-time
archived (optional)
Date format: date-time

Terminology - Up

id (optional)
versions
code
String Terminology code and unique identifier. Must be defined.
name
String Terminology name. Must be defined.
contact
String Contact person and/or organization. Must be defined.
description
String Longer description of a terminology. Must be defined.
copyright (optional)
String Copyright notice when using a specific terminology.
documentation (optional)
String Further information/documentation on a given terminology.
confirmation_checkbox_text (optional)
String Text to show next to the checkbox the user needs to tick before being able to download the file. If left empty, it will NOT show a dialog when the user attempts to download a file.
confirmation_description (optional)
String Additional text to show below the checkbox the user needs to tick before being able to download the file. If you specify text here, you MUST also specify text for the checkbox.

Terminology_versions_inner - Up

id (optional)
files
name
String Version name. Must be defined.
released (optional)
date Date at which a given terminology file has been released. Must be defined. format: date
status (optional)
Enum:
ACTIVE
ARCHIVED

Terminology_versions_inner_files_inner - Up

id (optional)
format (optional)
confirmation_checkbox_text (optional)
confirmation_description (optional)

TermsOfUse - Up

id (optional)
created (optional)
Date format: date-time
node
Integer The node to which the terms of use belong.
version_type
String Which type of version this is. See VersionType for details.
Enum:
MINOR
MAJOR
version
String The version of the terms of use.
text
String The terms of use content.
users (optional)

TermsOfUseAcceptance - Up

user
Integer Which user this acceptance belongs to.
terms_of_use
Integer Which terms of use were accepted.

TermsOfUseLite - Up

id (optional)
created (optional)
Date format: date-time
node
Integer The node to which the terms of use belong.
version_type
String Which type of version this is. See VersionType for details.
Enum:
MINOR
MAJOR
version
String The version of the terms of use.
text
String The terms of use content.

TermsOfUse_users_inner - Up

first_name
last_name
email
String format: email
accepted_at
Date format: date-time

UniqueDataProvider - Up

id (optional)
code (optional)
name (optional)

UniqueFlag - Up

id (optional)
code (optional)

UniqueGroup - Up

id (optional)
name (optional)

UniqueNode - Up

id (optional)
code (optional)
name (optional)

UniquePgpKeyInfo - Up

id (optional)
fingerprint (optional)

UniqueProject - Up

id (optional)
gid (optional)
code (optional)
name (optional)

UniqueUser - Up

id (optional)
username (optional)
email (optional)
String format: email

User - Up

id (optional)
last_login (optional)
Date format: date-time
display_name (optional)
String User's display name
terms_of_use (optional)
open_pgp_keys (optional)
profile (optional)
username (optional)
email (optional)
String format: email
first_name (optional)
last_name (optional)
groups (optional)
flags (optional)
is_active (optional)
Boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

UserLite - Up

first_name (optional)
groups (optional)
id (optional)
is_active (optional)
Boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_login (optional)
Date format: date-time
last_name (optional)
email (optional)
String format: email
username (optional)
display_name (optional)
String User's display name
open_pgp_keys (optional)

UserLite_open_pgp_keys_inner - Up

fingerprint
status (optional)
Enum:
APPROVED
APPROVAL_REVOKED
DELETED
KEY_REVOKED
PENDING
REJECTED
id (optional)
key_user_id (optional)
key_email (optional)
String format: email

UserNamespace - Up

id (optional)
name

User_profile - Up

affiliation (optional)
affiliation_id (optional)
uid (optional)
gid (optional)
emails (optional)
local_username
display_name (optional)
display_id (optional)
namespace (optional)
display_local_username (optional)
affiliation_consent (optional)
custom_affiliation (optional)

User_terms_of_use_inner - Up

id
node
version
accepted_at
Date format: date-time

Userinfo - Up

ip_address (optional)
permissions (optional)
manages (optional)
flags (optional)
groups (optional)
username
String Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
email (optional)
String format: email
first_name (optional)
last_name (optional)
profile (optional)
id

Userinfo_manages - Up

List of entities (data provider/node) the user is being admin of.
data_provider_admin (optional)
node_admin (optional)

Userinfo_permissions - Up

List of permissions currently held by the user. Note that the permissions are project/data provider/node agnostic: one association is sufficient to get true here.
manager (optional)
Boolean Whether current user is either a project manager (PM) or a project leader (PL)
staff (optional)
data_manager (optional)
project_leader (optional)
data_provider_admin (optional)
data_provider_viewer (optional)
node_admin (optional)
node_viewer (optional)
group_manager (optional)
Boolean Whether current user is allowed to manage groups (a node/data provider manager for instance)
has_projects (optional)
legal_approver (optional)
Boolean Whether current user is allowed to approve DTR legal approvals
data_specification_approver (optional)
Boolean Whether current user is allowed to approve DTR group data specification approvals

Userinfo_profile - Up

affiliation (optional)
affiliation_id (optional)
uid (optional)
gid (optional)
emails (optional)
local_username
display_name (optional)
display_id (optional)
namespace (optional)
display_local_username (optional)
affiliation_consent (optional)
custom_affiliation (optional)

VersionFileDownload - Up

id