API docs by Redocly

Sharing role integration API (0.0.1)

Sharing role integration API

roles

start sharing role

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

Request Body schema: application/json
required

Sharing roles object

roleId
required
string <uuid>

id of sharing role record

roleName
required
string

name of sharing role

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body

Responses

Request samples

Content type
application/json
{
  • "roleId": "3844767a-8367-4926-9999-514c35840399",
  • "roleName": "role name",
  • "url": "/roles",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "createPCIds": [
    ],
  • "updatePCIds": [
    ]
}

delete sharing role

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

roleId
required
string <uuid> (uuid)

The ID of role

Request Body schema: application/json
required

Sharing roles object

roleId
required
string <uuid>

id of sharing role record

roleName
required
string

name of sharing role

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body

Responses

Request samples

Content type
application/json
{
  • "roleId": "3844767a-8367-4926-9999-514c35840399",
  • "roleName": "role name",
  • "url": "/roles",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "pcIds": [
    ]
}

role-capability-set

start sharing role capability sets

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

Request Body schema: application/json
required

Sharing role capability sets object

roleId
required
string <uuid>

id of sharing role record

roleName
required
string

name of sharing role

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body that contains roleId, capability set names

Responses

Request samples

Content type
application/json
{
  • "roleId": "4844767a-8367-4926-9999-514c35840399",
  • "roleName": "test",
  • "url": "/roles/capability-sets",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "createPCIds": [
    ],
  • "updatePCIds": [
    ]
}

delete sharing role capability set

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

roleId
required
string <uuid> (uuid)

The ID of role

Request Body schema: application/json
required

Sharing role capability sets object

roleId
required
string <uuid>

id of sharing role record

roleName
required
string

name of sharing role

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body that contains roleId, capability set names

Responses

Request samples

Content type
application/json
{
  • "roleId": "4844767a-8367-4926-9999-514c35840399",
  • "roleName": "test",
  • "url": "/roles/capability-sets",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "pcIds": [
    ]
}

role-capabilities

start sharing role capabilities

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

Request Body schema: application/json
required

Sharing role capabilities object

roleId
required
string <uuid>

id of sharing role record

roleName
required
string

name of sharing role

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body that contains roleId, capability names

Responses

Request samples

Content type
application/json
{
  • "roleId": "5844767a-8367-4926-9999-514c35840399",
  • "roleName": "don't panic",
  • "url": "/roles/capabilities",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "createPCIds": [
    ],
  • "updatePCIds": [
    ]
}

delete sharing role capabilities

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

roleId
required
string <uuid> (uuid)

The ID of role

Request Body schema: application/json
required

Sharing role capabilities object

roleId
required
string <uuid>

id of sharing role record

roleName
required
string

name of sharing role

url
required
string

URL for publishing requests for consortia tenants

payload
object

Http request body that contains roleId, capability names

Responses

Request samples

Content type
application/json
{
  • "roleId": "5844767a-8367-4926-9999-514c35840399",
  • "roleName": "don't panic",
  • "url": "/roles/capabilities",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "pcIds": [
    ]
}