FURMS messaging API for site agents 1.0.0

Introduction to the Async API is available here

Operations

Sub site/site_id/project/provision/req

Provision a project to site

Installation of a project on a site will happen when the first resource of the site is allocated to the project.

Accepts the following message:

ProjectInstallationRequest

Payload

object

identifier

string

generated by FURMS, unique, persistent

name

string

project name

description

string

acronym

string

communityId

string

community

string

researchField

string

validityStart

string

dateTime

validityEnd

string

dateTime

projectLeader userRecord

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

title

string

firstName

string

lastName

string

gender

string

nationality

string

phone

string

placeOfBirth

string

dateOfBirth

string

date

organizationName

string

organizationAddress

string

organizationPostalCode

string

organizationCountry

string

organizationPhone

string

homeAddress

string

homePostalCode

string

homeCountry

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

ProjectInstallationRequest

Payload

{
  "identifier": "string",
  "name": "string",
  "description": "string",
  "acronym": "string",
  "communityId": "string",
  "community": "string",
  "researchField": "string",
  "validityStart": "string",
  "validityEnd": "string",
  "projectLeader": {
    "fenixUserId": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": "string",
    "nationality": "string",
    "email": "string",
    "phone": "string",
    "placeOfBirth": "string",
    "dateOfBirth": "2019-08-24",
    "organizationName": "string",
    "organizationAddress": "string",
    "organizationPostalCode": "string",
    "organizationCountry": "string",
    "organizationPhone": "string",
    "homeAddress": "string",
    "homePostalCode": "string",
    "homeCountry": "string"
  }
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/project/provision/ack

Acknowledge request

Accepts the following message:

ProjectInstallationRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectInstallationRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/project/provision/resp

Acknowledge project installation on site

Site agents must send information to FURMS whenever a project is installed on a site or if project installation fails.

Accepts the following message:

ProjectInstallationResult

Payload

object

attributes

object

gid

string

GID of the created group, not required in case of error

Additional properties are allowed.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectInstallationResult

Payload

{
  "attributes": {
    "gid": "string"
  }
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/project/removal/req

Remove a project from a site

Project removal will be requested by FURMS when previously installed project lifetime ends.

Accepts the following message:

ProjectRemovalRequest

Payload

object

identifier

string

generated by FURMS, unique, persistent

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

ProjectRemovalRequest

Payload

{
  "identifier": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/project/removal/ack

Acknowledge removal request

Accepts the following message:

ProjectRemovalRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectRemovalRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/project/removal/resp

Acknowledge project removal on a site

Project removal or removal failure must be communicated to FURMS with the following message.

Accepts the following message:

ProjectRemovalResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectRemovalResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/project/update/req

Update a project on a site

Project metadata can change in FURMS. In such cases, a project update request will be sent to a site.

Accepts the following message:

ProjectUpdateRequest

Payload

object

identifier

string

generated by FURMS, unique, persistent

name

string

project name

description

string

researchField

string

acronym

string

validityStart

string

dateTime

validityEnd

string

dateTime

projectLeader userRecord

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

title

string

firstName

string

lastName

string

gender

string

nationality

string

phone

string

placeOfBirth

string

dateOfBirth

string

date

organizationName

string

organizationAddress

string

organizationPostalCode

string

organizationCountry

string

organizationPhone

string

homeAddress

string

homePostalCode

string

homeCountry

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

ProjectUpdateRequest

Payload

{
  "identifier": "string",
  "name": "string",
  "description": "string",
  "researchField": "string",
  "acronym": "string",
  "validityStart": "string",
  "validityEnd": "string",
  "projectLeader": {
    "fenixUserId": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": "string",
    "nationality": "string",
    "email": "string",
    "phone": "string",
    "placeOfBirth": "string",
    "dateOfBirth": "2019-08-24",
    "organizationName": "string",
    "organizationAddress": "string",
    "organizationPostalCode": "string",
    "organizationCountry": "string",
    "organizationPhone": "string",
    "homeAddress": "string",
    "homePostalCode": "string",
    "homeCountry": "string"
  }
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/project/update/ack

Acknowledge update request

Accepts the following message:

ProjectUpdateRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectUpdateRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/project/update/resp

Acknowledge project update on site

Site agents must send information to FURMS whenever the project is updated or if the project update fails.

Accepts the following message:

ProjectUpdateResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectUpdateResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/user/status/req

Suspend/enable user on site

Shall be used by FURMS to signal the site that user access to the site should be suspended or re-enabled.

Accepts the following message:

SetUserStatusRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

status

string

Enum: "ENABLED" "DISABLED"

reason

string

Enum: "security_incident"

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

SetUserStatusRequest

Payload

{
  "fenixUserId": "string",
  "status": "ENABLED",
  "reason": "security_incident"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/user/status/ack

Acknowledge status update request

Accepts the following message:

SetUserStatusRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

SetUserStatusRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/user/status/resp

Acknowledge user status change on a site

Accepts the following message:

SetUserStatusResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

SetUserStatusResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/sshkey/add/req

Install user's SSH key

Is used to request SSH key installation on a site

Accepts the following message:

UserSSHKeyAddRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

publicKey

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

UserSSHKeyAddRequest

Payload

{
  "fenixUserId": "string",
  "publicKey": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/sshkey/add/ack

Acknowledge SSH key add request

Accepts the following message:

UserSSHKeyAddRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserSSHKeyAddRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/sshkey/add/resp

Acknowledge adding SSH key

Accepts the following message:

UserSSHKeyAddResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserSSHKeyAddResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/sshkey/update/req

Update user's SSH key

Is used to request SSH key update on a site

Accepts the following message:

UserSSHKeyUpdateRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

oldPublicKey

string

newPublicKey

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

UserSSHKeyUpdateRequest

Payload

{
  "fenixUserId": "string",
  "oldPublicKey": "string",
  "newPublicKey": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/sshkey/update/ack

Acknowledge SSH key update request

Accepts the following message:

UserSSHKeyUpdateRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserSSHKeyUpdateRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/sshkey/update/resp

Acknowledge updating SSH key

Accepts the following message:

UserSSHKeyUpdateResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserSSHKeyUpdateResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/sshkey/remove/req

Remove user's SSH key

Used to request SSH key removal on a site

Accepts the following message:

UserSSHKeyRemovalRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

publicKey

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

UserSSHKeyRemovalRequest

Payload

{
  "fenixUserId": "string",
  "publicKey": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/sshkey/remove/ack

Acknowledge SSH key removal request

Accepts the following message:

UserSSHKeyRemovalRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserSSHKeyRemovalRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/sshkey/remove/resp

Acknowledge adding SSH key

Accepts the following message:

UserSSHKeyRemovalResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserSSHKeyRemovalResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/project/user_add/req

Add user to a project

Sent by FURMS to request adding a user to a project.

Accepts the following message:

UserProjectAddRequest

Payload

object

user userRecord

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

title

string

firstName

string

lastName

string

gender

string

nationality

string

phone

string

placeOfBirth

string

dateOfBirth

string

date

organizationName

string

organizationAddress

string

organizationPostalCode

string

organizationCountry

string

organizationPhone

string

homeAddress

string

homePostalCode

string

homeCountry

string

Additional properties are NOT allowed.

policiesAcceptance

array<object>

policyIdentifier

string

currentVersion

number

integer

serviceIdentifier

string

only for service policies

processedVersion

number

integer

acceptance

string

Enum: "ACCEPTED" "REJECTED" "UNKNOWN"

Additional items are allowed.

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

UserProjectAddRequest

Payload

{
  "user": {
    "fenixUserId": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": "string",
    "nationality": "string",
    "email": "string",
    "phone": "string",
    "placeOfBirth": "string",
    "dateOfBirth": "2019-08-24",
    "organizationName": "string",
    "organizationAddress": "string",
    "organizationPostalCode": "string",
    "organizationCountry": "string",
    "organizationPhone": "string",
    "homeAddress": "string",
    "homePostalCode": "string",
    "homeCountry": "string"
  },
  "policiesAcceptance": [
    {
      "policyIdentifier": "string",
      "currentVersion": 0,
      "serviceIdentifier": "string",
      "processedVersion": 0,
      "acceptance": "ACCEPTED"
    }
  ],
  "projectIdentifier": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/project/user_add/ack

Acknowledge user add to project request

Accepts the following message:

UserProjectAddRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserProjectAddRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/project/user_add/resp

User to project add result

Should be sent by the site agent to indicate user addition (or failure of) to a project.

Accepts the following message:

UserProjectAddResult

Payload

object

uid uid

string

Local site-assigned account id aka Unix user id.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserProjectAddResult

Payload

{
  "uid": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/project/user_remove/req

Remove user from a project

Should be sent by FURMS to request removal of a user from a project.

Accepts the following message:

UserProjectRemovalRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

UserProjectRemovalRequest

Payload

{
  "fenixUserId": "string",
  "projectIdentifier": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/project/user_remove/ack

Acknowledge user removal from project request

Accepts the following message:

UserProjectRemovalRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserProjectRemovalRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/project/user_remove/resp

User removal from project result

Should be sent by the site agent when a user was removed from a project or removal failed.

Accepts the following message:

UserProjectRemovalResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserProjectRemovalResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/resource/allocate/req

Request resource allocation to a project

Will be sent by FURMS to inform the site that part of resource credit defined by the site admin in FURMS was allocated to a (previously provisioned) project. Note that this may be either an initial allocation or an update of the allocation. In the latter case the allocationIdentifier parameter should be already known to the site.

Accepts the following message:

ProjectResourceAllocationRequest

Payload

object

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

resourceCreditIdentifier

string

Can be used to correlate the request with resource credit as configured in FURMS by site admin.

resourceType

string

amount

number

double

validFrom

string

dateTime

validTo

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

ProjectResourceAllocationRequest

Payload

{
  "projectIdentifier": "string",
  "allocationIdentifier": "string",
  "resourceCreditIdentifier": "string",
  "resourceType": "string",
  "amount": 0,
  "validFrom": "string",
  "validTo": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/resource/allocate/ack

Acknowledge allocate resource to a project request

Accepts the following message:

ProjectResourceAllocationRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectResourceAllocationRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/resource/allocate/status/result

Confirm allocation installation or update

Accepts the following message:

ProjectResourceAllocationStatusResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectResourceAllocationStatusResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/resource/allocate/resp

Information about allocated resources

In case when a request is generally accepted, the site should actually allocate resources. Since the allocation scheme can vary from site to site, the site agent can report multiple allocations, with different amounts then the requested ones. Reporting of allocation is communicated with the message ResourceAllocationResult. In case when an allocation failed, only the first ResourceAllocationResult can be used to send an error status, subsequent responses won't be accepted.

Accepts the following message:

ProjectResourceAllocationResult

Payload

object

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

allocationChunkIdentifier

string

Identifies chunk assigned by site under the requested allocationIdentifier. Single FURMS allocation can be realized with multiple chunks.

amount

number

double

validFrom

string

dateTime

validTo

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectResourceAllocationResult

Payload

{
  "allocationIdentifier": "string",
  "allocationChunkIdentifier": "string",
  "amount": 0,
  "validFrom": "string",
  "validTo": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/resource/allocate/update

Update of allocated resources

Carries an update of a previously sent allocation with the ResourceAllocationResult message. Messages with failed status won't be accepted.

Accepts the following message:

ProjectResourceAllocationUpdate

Payload

object

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

allocationChunkIdentifier

string

Identifies the updated chunk.

amount

number

double

validFrom

string

dateTime

validTo

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectResourceAllocationUpdate

Payload

{
  "allocationIdentifier": "string",
  "allocationChunkIdentifier": "string",
  "amount": 0,
  "validFrom": "string",
  "validTo": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/resource/deallocate/req

Remove resource allocation from a project

Will be sent by FURMS to inform the site that a formerly allocated resource allocation was removed from a project

Accepts the following message:

ProjectResourceDeallocationRequest

Payload

object

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

resourceCreditIdentifier

string

resourceType

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

ProjectResourceDeallocationRequest

Payload

{
  "projectIdentifier": "string",
  "allocationIdentifier": "string",
  "resourceCreditIdentifier": "string",
  "resourceType": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/resource/deallocate/ack

Acknowledge deallocation request

Accepts the following message:

ProjectResourceDeallocationRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

ProjectResourceDeallocationRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/allocation/user_add/req

Request to grant user access to allocation

Sent by FURMS to request granting user rights to an allocation within a project.

Accepts the following message:

UserAllocationGrantAccessRequest

Payload

object

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

user userRecord

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

title

string

firstName

string

lastName

string

gender

string

nationality

string

phone

string

placeOfBirth

string

dateOfBirth

string

date

organizationName

string

organizationAddress

string

organizationPostalCode

string

organizationCountry

string

organizationPhone

string

homeAddress

string

homePostalCode

string

homeCountry

string

Additional properties are NOT allowed.

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

policiesAcceptance policiesAcceptance

array<object>

policyAcceptance policyAcceptanceContent

object

policyIdentifier

string

currentVersion

integer

serviceIdentifier

string

only used for service policies

processedVersion

integer

acceptance

string

Enum: "REJECTED" "ACCEPTED" "UNKNOWN"

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

UserAllocationGrantAccessRequest

Payload

{
  "allocationIdentifier": "string",
  "user": {
    "fenixUserId": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": "string",
    "nationality": "string",
    "email": "string",
    "phone": "string",
    "placeOfBirth": "string",
    "dateOfBirth": "2019-08-24",
    "organizationName": "string",
    "organizationAddress": "string",
    "organizationPostalCode": "string",
    "organizationCountry": "string",
    "organizationPhone": "string",
    "homeAddress": "string",
    "homePostalCode": "string",
    "homeCountry": "string"
  },
  "projectIdentifier": "string",
  "policiesAcceptance": [
    {
      "policyAcceptance": {
        "policyIdentifier": "string",
        "currentVersion": 0,
        "serviceIdentifier": "string",
        "processedVersion": 0,
        "acceptance": "REJECTED"
      }
    }
  ]
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/allocation/user_add/ack

Acknowledge grant user access to allocation request

Accepts the following message:

UserAllocationGrantAccessRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserAllocationGrantAccessRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/allocation/user_add/resp

Grant user access to allocation

Should be sent by the site agent to indicate granting user access to allocation.

Accepts the following message:

UserAllocationGrantAccessResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserAllocationGrantAccessResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/allocation/user_remove/req

Request removal of user's access to allocation

Sent by FURMS to request removing the previously granted access to an allocation for a user.

Accepts the following message:

UserAllocationBlockAccessRequest

Payload

object

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

UserAllocationBlockAccessRequest

Payload

{
  "allocationIdentifier": "string",
  "fenixUserId": "string",
  "projectIdentifier": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/allocation/user_remove/ack

Acknowledge remove user's access to allocation request

Accepts the following message:

UserAllocationBlockAccessRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserAllocationBlockAccessRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/allocation/user_remove/resp

Signal removal of user's access to allocation

Should be sent by the site agent to indicate that user's access to an allocation was blocked.

Accepts the following message:

UserAllocationBlockAccessResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserAllocationBlockAccessResult

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Pub site/site_id/resource_usage/cumulative

Cumulative allocation usage record

Sent from the site agent to FURMS to report per-project and allocation resource consumption.

Accepts the following message:

CumulativeResourceUsageRecord

Payload

object

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

cumulativeConsumption

number

double

probedAt

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

Examples

CumulativeResourceUsageRecord

Payload

{
  "projectIdentifier": "string",
  "allocationIdentifier": "string",
  "cumulativeConsumption": 0,
  "probedAt": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1
}

This example has been generated automatically.

Pub site/site_id/resource_usage/user

Per-user allocation usage record

Sent from the site agent to FURMS to report per-project, user and allocation resource consumption.

Accepts the following message:

UserResourceUsageRecord

Payload

object

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

cumulativeConsumption

number

double

consumedUntil

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

Examples

UserResourceUsageRecord

Payload

{
  "projectIdentifier": "string",
  "allocationIdentifier": "string",
  "fenixUserId": "string",
  "cumulativeConsumption": 0,
  "consumedUntil": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1
}

This example has been generated automatically.

Sub site/site_id/error/info

Error info callback

Sent from FURMS to site agent to report message handling errors.

Accepts the following message:

AgentMessageErrorInfo

Payload

object

correlationId

string

Correlation id of the problematic message

errorType

string

Type of problem

Enum: "InvalidMessageContent" "InvalidSiteId" "InvalidCorrelationId" "IllegalStateTransition" "IllegalArgument" "UnsupportedFailedChunk"

description

string

Human readable description

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

Examples

AgentMessageErrorInfo

Payload

{
  "correlationId": "string",
  "errorType": "InvalidMessageContent",
  "description": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1
}

This example has been generated automatically.

Sub site/site_id/ping/req

Ping agent

Used by FURMS to check if the site agent is on-line. The request has an empty body, and RequestAck is used to determine availability.

Accepts the following message:

AgentPingRequest

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

Examples

AgentPingRequest

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string"
}

This example has been generated automatically.

Pub site/site_id/ping/ack

Acknowledge ping request

Accepts the following message:

AgentPingRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

AgentPingRequestAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/policy/acceptance_update

Policy acceptance update

Used by FURMS to inform site agent that user's policies acceptance status has been changed.

Accepts the following message:

UserPolicyAcceptanceUpdate

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

policiesAcceptance policiesAcceptance

array<object>

policyAcceptance policyAcceptanceContent

object

policyIdentifier

string

currentVersion

integer

serviceIdentifier

string

only used for service policies

processedVersion

integer

acceptance

string

Enum: "REJECTED" "ACCEPTED" "UNKNOWN"

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

Examples

UserPolicyAcceptanceUpdate

Payload

{
  "fenixUserId": "string",
  "policiesAcceptance": [
    {
      "policyAcceptance": {
        "policyIdentifier": "string",
        "currentVersion": 0,
        "serviceIdentifier": "string",
        "processedVersion": 0,
        "acceptance": "REJECTED"
      }
    }
  ]
}

This example has been generated automatically.

Headers

{
  "version": 1
}

This example has been generated automatically.

Pub site/site_id/policy/acceptance_update/ack

Acknowledge acceptance update request

Accepts the following message:

UserPolicyAcceptanceUpdateAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

UserPolicyAcceptanceUpdateAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Sub site/site_id/policy/update

Policy document update

Used by FURMS to inform site agent that a policy has been updated

Accepts the following message:

PolicyUpdate

Payload

object

policyIdentifier

string

policyName

string

currentVersion

integer

serviceIdentifier

string

only used for service policies

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

Examples

PolicyUpdate

Payload

{
  "policyIdentifier": "string",
  "policyName": "string",
  "currentVersion": 0,
  "serviceIdentifier": "string"
}

This example has been generated automatically.

Headers

{
  "version": 1
}

This example has been generated automatically.

Pub site/site_id/policy/update/ack

Acknowledge policy update request

Accepts the following message:

PolicyUpdateAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

Examples

PolicyUpdateAck

Payload

{}

This example has been generated automatically.

Headers

{
  "version": 1,
  "messageCorrelationId": "string",
  "status": "OK",
  "error": {
    "code": "string",
    "message": "string"
  }
}

This example has been generated automatically.

Messages

#1 ProjectInstallationRequest

Payload

object

identifier

string

generated by FURMS, unique, persistent

name

string

project name

description

string

acronym

string

communityId

string

community

string

researchField

string

validityStart

string

dateTime

validityEnd

string

dateTime

projectLeader userRecord

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

title

string

firstName

string

lastName

string

gender

string

nationality

string

phone

string

placeOfBirth

string

dateOfBirth

string

date

organizationName

string

organizationAddress

string

organizationPostalCode

string

organizationCountry

string

organizationPhone

string

homeAddress

string

homePostalCode

string

homeCountry

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#2 ProjectInstallationRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#3 ProjectInstallationResult

Payload

object

attributes

object

gid

string

GID of the created group, not required in case of error

Additional properties are allowed.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#4 ProjectRemovalRequest

Payload

object

identifier

string

generated by FURMS, unique, persistent

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#5 ProjectRemovalRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#6 ProjectRemovalResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#7 ProjectUpdateRequest

Payload

object

identifier

string

generated by FURMS, unique, persistent

name

string

project name

description

string

researchField

string

acronym

string

validityStart

string

dateTime

validityEnd

string

dateTime

projectLeader userRecord

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

title

string

firstName

string

lastName

string

gender

string

nationality

string

phone

string

placeOfBirth

string

dateOfBirth

string

date

organizationName

string

organizationAddress

string

organizationPostalCode

string

organizationCountry

string

organizationPhone

string

homeAddress

string

homePostalCode

string

homeCountry

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#8 ProjectUpdateRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#9 ProjectUpdateResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#10 SetUserStatusRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

status

string

Enum: "ENABLED" "DISABLED"

reason

string

Enum: "security_incident"

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#11 SetUserStatusRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#12 SetUserStatusResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#13 UserSSHKeyAddRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

publicKey

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#14 UserSSHKeyAddRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#15 UserSSHKeyAddResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#16 UserSSHKeyUpdateRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

oldPublicKey

string

newPublicKey

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#17 UserSSHKeyUpdateRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#18 UserSSHKeyUpdateResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#19 UserSSHKeyRemovalRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

publicKey

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#20 UserSSHKeyRemovalRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#21 UserSSHKeyRemovalResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#22 UserProjectAddRequest

Payload

object

user userRecord

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

title

string

firstName

string

lastName

string

gender

string

nationality

string

phone

string

placeOfBirth

string

dateOfBirth

string

date

organizationName

string

organizationAddress

string

organizationPostalCode

string

organizationCountry

string

organizationPhone

string

homeAddress

string

homePostalCode

string

homeCountry

string

Additional properties are NOT allowed.

policiesAcceptance

array<object>

policyIdentifier

string

currentVersion

number

integer

serviceIdentifier

string

only for service policies

processedVersion

number

integer

acceptance

string

Enum: "ACCEPTED" "REJECTED" "UNKNOWN"

Additional items are allowed.

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#23 UserProjectAddRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#24 UserProjectAddResult

Payload

object

uid uid

string

Local site-assigned account id aka Unix user id.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#25 UserProjectRemovalRequest

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#26 UserProjectRemovalRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#27 UserProjectRemovalResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#28 ProjectResourceAllocationRequest

Payload

object

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

resourceCreditIdentifier

string

Can be used to correlate the request with resource credit as configured in FURMS by site admin.

resourceType

string

amount

number

double

validFrom

string

dateTime

validTo

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#29 ProjectResourceAllocationRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#30 ProjectResourceAllocationStatusResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#31 ProjectResourceAllocationResult

Payload

object

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

allocationChunkIdentifier

string

Identifies chunk assigned by site under the requested allocationIdentifier. Single FURMS allocation can be realized with multiple chunks.

amount

number

double

validFrom

string

dateTime

validTo

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#32 ProjectResourceAllocationUpdate

Payload

object

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

allocationChunkIdentifier

string

Identifies the updated chunk.

amount

number

double

validFrom

string

dateTime

validTo

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#33 ProjectResourceDeallocationRequest

Payload

object

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

resourceCreditIdentifier

string

resourceType

string

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#34 ProjectResourceDeallocationRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#35 UserAllocationGrantAccessRequest

Payload

object

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

user userRecord

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

title

string

firstName

string

lastName

string

gender

string

nationality

string

phone

string

placeOfBirth

string

dateOfBirth

string

date

organizationName

string

organizationAddress

string

organizationPostalCode

string

organizationCountry

string

organizationPhone

string

homeAddress

string

homePostalCode

string

homeCountry

string

Additional properties are NOT allowed.

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

policiesAcceptance policiesAcceptance

array<object>

policyAcceptance policyAcceptanceContent

object

policyIdentifier

string

currentVersion

integer

serviceIdentifier

string

only used for service policies

processedVersion

integer

acceptance

string

Enum: "REJECTED" "ACCEPTED" "UNKNOWN"

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#36 UserAllocationGrantAccessRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#37 UserAllocationGrantAccessResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#38 UserAllocationBlockAccessRequest

Payload

object

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#39 UserAllocationBlockAccessRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#40 UserAllocationBlockAccessResult

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#41 CumulativeResourceUsageRecord

Payload

object

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

cumulativeConsumption

number

double

probedAt

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

#42 UserResourceUsageRecord

Payload

object

projectIdentifier projectIdentifier

string

FURMS assigned, unique identifier of a project.

allocationIdentifier allocationIdentifier

string

FURMS assigned, unique identifier of a particular project allocation. Single resource credit can have many allocations.

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

cumulativeConsumption

number

double

consumedUntil

string

dateTime

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

#43 AgentMessageErrorInfo

Payload

object

correlationId

string

Correlation id of the problematic message

errorType

string

Type of problem

Enum: "InvalidMessageContent" "InvalidSiteId" "InvalidCorrelationId" "IllegalStateTransition" "IllegalArgument" "UnsupportedFailedChunk"

description

string

Human readable description

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

#44 AgentPingRequest

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

Additional properties are NOT allowed.

#45 AgentPingRequestAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#46 UserPolicyAcceptanceUpdate

Payload

object

fenixUserId fenixUserId

string

Fenix-wide identifier of a person, managed by Fenix Central IdP

policiesAcceptance policiesAcceptance

array<object>

policyAcceptance policyAcceptanceContent

object

policyIdentifier

string

currentVersion

integer

serviceIdentifier

string

only used for service policies

processedVersion

integer

acceptance

string

Enum: "REJECTED" "ACCEPTED" "UNKNOWN"

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

#47 UserPolicyAcceptanceUpdateAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#48 PolicyUpdate

Payload

object

policyIdentifier

string

policyName

string

currentVersion

integer

serviceIdentifier

string

only used for service policies

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

Additional properties are NOT allowed.

#49 PolicyUpdateAck

Payload emptyObject

object

Additional properties are NOT allowed.

Headers

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.

#50 requestAck

Payload

object

Additional properties are NOT allowed.

Headers responseMeta

object

version

integer

Default: 1

messageCorrelationId

string

status

required

string

Enum: "OK" "FAILED"

error

object

optional, only present if status=FAILED

code

string

message

string

Additional properties are NOT allowed.