API intended for use by Fenix Central IdP, providing access to FURMS user attributes and basic user management.
{- "status": "ENABLED"
}
Returns a complete information about a given user for specific site, including project membership and global attributes.
fenixUserId required | string |
oauthClientId required | string |
{- "user": {
- "fenixIdentifier": "string",
- "title": "string",
- "firstname": "string",
- "lastname": "string",
- "email": "string",
- "affiliation": {
- "name": "string",
- "email": "string",
- "country": "string",
- "postalAddress": "string"
}, - "nationality": "string",
- "phone": "string",
- "dateOfBirth": "2019-08-24",
- "placeOfBirth": "string",
- "postalAddress": "string"
}, - "userStatus": "ENABLED",
- "siteAccess": [
- {
- "siteId": "string",
- "siteOauthClientId": "string",
- "projectMemberships": [
- {
- "localUserId": "string",
- "projectId": "string"
}
], - "sitePolicyAcceptance": {
- "policyId": "string",
- "acceptanceStatus": "ACCEPTED",
- "processedOn": "2019-08-24T14:15:22Z",
- "currentVersion": 0,
- "processedVersion": 0
}, - "servicesPolicyAcceptance": [
- {
- "policyId": "string",
- "acceptanceStatus": "ACCEPTED",
- "processedOn": "2019-08-24T14:15:22Z",
- "currentVersion": 0,
- "processedVersion": 0
}
], - "sshKeys": [
- "string"
]
}
], - "groupAccess": [
- {
- "communityId": "string",
- "groups": [
- "string"
]
}
]
}
Returns a complete information about a given user, including project membership and global attributes.
fenixUserId required | string |
{- "user": {
- "fenixIdentifier": "string",
- "title": "string",
- "firstname": "string",
- "lastname": "string",
- "email": "string",
- "affiliation": {
- "name": "string",
- "email": "string",
- "country": "string",
- "postalAddress": "string"
}, - "nationality": "string",
- "phone": "string",
- "dateOfBirth": "2019-08-24",
- "placeOfBirth": "string",
- "postalAddress": "string"
}, - "userStatus": "ENABLED",
- "siteAccess": [
- {
- "siteId": "string",
- "siteOauthClientId": "string",
- "projectMemberships": [
- {
- "localUserId": "string",
- "projectId": "string"
}
], - "sitePolicyAcceptance": {
- "policyId": "string",
- "acceptanceStatus": "ACCEPTED",
- "processedOn": "2019-08-24T14:15:22Z",
- "currentVersion": 0,
- "processedVersion": 0
}, - "servicesPolicyAcceptance": [
- {
- "policyId": "string",
- "acceptanceStatus": "ACCEPTED",
- "processedOn": "2019-08-24T14:15:22Z",
- "currentVersion": 0,
- "processedVersion": 0
}
], - "sshKeys": [
- "string"
]
}
], - "groupAccess": [
- {
- "communityId": "string",
- "groups": [
- "string"
]
}
]
}
FURMS administration endpoint that provides comprehensive access to information about sites as well as exposes basic operations that can be done in a site context.
Returns complete information about all sites including their allocations, resource types, services and policies.
[- {
- "id": "string",
- "name": "string",
- "sitePolicyId": "string",
- "resourceCredits": [
- {
- "creditId": "string",
- "name": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "resourceTypeId": "string",
- "amount": {
- "amount": 0,
- "unit": "string"
}
}
], - "resourceTypes": [
- {
- "typeId": "string",
- "name": "string",
- "serviceId": "string"
}
], - "services": [
- {
- "serviceId": "string",
- "name": "string",
- "policyId": "string"
}
], - "policies": [
- {
- "policyId": "string",
- "name": "string",
- "revision": 0
}
]
}
]
Returns complete information about a site, including its all allocations, resource types, services and policies
siteId required | string |
{- "id": "string",
- "name": "string",
- "sitePolicyId": "string",
- "resourceCredits": [
- {
- "creditId": "string",
- "name": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "resourceTypeId": "string",
- "amount": {
- "amount": 0,
- "unit": "string"
}
}
], - "resourceTypes": [
- {
- "typeId": "string",
- "name": "string",
- "serviceId": "string"
}
], - "services": [
- {
- "serviceId": "string",
- "name": "string",
- "policyId": "string"
}
], - "policies": [
- {
- "policyId": "string",
- "name": "string",
- "revision": 0
}
]
}
Retrieve all resource credits of a site.
siteId required | string |
[- {
- "creditId": "string",
- "name": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "resourceTypeId": "string",
- "amount": {
- "amount": 0,
- "unit": "string"
}
}
]
Retrieve details of a given resource credit.
siteId required | string |
creditId required | string |
{- "creditId": "string",
- "name": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "resourceTypeId": "string",
- "amount": {
- "amount": 0,
- "unit": "string"
}
}
Returns list of all site's users with policies and status whether given policy is accepcted or not.
siteId required | string |
[- {
- "fenixUserId": "string",
- "policyId": "string",
- "acceptanceStatus": "ACCEPTED",
- "processedOn": "2019-08-24T14:15:22Z",
- "currentPolicyRevision": 0,
- "acceptedRevision": 0
}
]
Returns all pending site's requests, which were sent to the site agent.
siteId required | string |
[- {
- "id": "string",
- "type": "USER_PROVISIONING",
- "status": "SENT",
- "sentOn": "2019-08-24T14:15:22Z",
- "ackOn": "2019-08-24T14:15:22Z"
}
]
Returns list of projects that should be installed on the site with details of installation status
siteId required | string |
[- {
- "project": {
- "id": "string",
- "acronym": "string",
- "name": "string",
- "communityId": "string",
- "researchField": "string",
- "installations": [
- {
- "siteId": "string",
- "gid": "string"
}
], - "description": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "projectLeader": {
- "fenixIdentifier": "string",
- "title": "string",
- "firstname": "string",
- "lastname": "string",
- "email": "string",
- "affiliation": {
- "name": "string",
- "email": "string",
- "country": "string",
- "postalAddress": "string"
}, - "nationality": "string",
- "phone": "string",
- "dateOfBirth": "2019-08-24",
- "placeOfBirth": "string",
- "postalAddress": "string"
}
}, - "installationStatus": "PENDING",
- "gid": "string"
}
]
Returns list of users that have access to the site through at least one of their projects. SSH key of each user is provided as well.
siteId required | string |
[- {
- "user": {
- "fenixIdentifier": "string",
- "title": "string",
- "firstname": "string",
- "lastname": "string",
- "email": "string",
- "affiliation": {
- "name": "string",
- "email": "string",
- "country": "string",
- "postalAddress": "string"
}, - "nationality": "string",
- "phone": "string",
- "dateOfBirth": "2019-08-24",
- "placeOfBirth": "string",
- "postalAddress": "string"
}, - "uid": "string",
- "sshKeys": [
- "string"
], - "projectIds": [
- "string"
]
}
]
Retrieve given project allocations at the site as assigned in FURMS
siteId required | string |
projectId required | string |
[- {
- "id": "string",
- "projectId": "string",
- "communityAllocationId": "string",
- "name": "string",
- "resourceTypeId": "string",
- "resourceUnit": "string",
- "siteId": "string",
- "siteName": "string",
- "serviceId": "string",
- "serviceName": "string",
- "amount": 0
}
]
Retrieve all project allocations at the site as assigned by the site
siteId required | string |
[- {
- "allocationId": "string",
- "siteId": "string",
- "projectId": "string",
- "amount": 0,
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}
}
]
Retrieve given project allocations at the site as assigned by the site
siteId required | string |
projectId required | string |
[- {
- "allocationId": "string",
- "siteId": "string",
- "projectId": "string",
- "amount": 0,
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}
}
]
Retrieve cumultaive resoruce consumption recorded by FURMS for a given project on a site.
siteId required | string |
projectId required | string |
[- {
- "projectAllocationId": "string",
- "siteId": "string",
- "resourceTypeId": "string",
- "consumedAmount": 0,
- "consumedUntil": "2019-08-24T14:15:22Z"
}
]
Retrieve individual resoruce usage records, stored by FURMS for a given project on a site. Records have per-user granularity. Caller can limit time range of records.
siteId required | string |
projectId required | string |
from | string <date-time> |
until | string <date-time> |
[- {
- "projectAllocationId": "string",
- "resourceTypeId": "string",
- "siteId": "string",
- "consumedAmount": 0,
- "userFenixId": "string",
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
]
Retrieve all project allocations at the site as assigned in FURMS
siteId required | string |
[- {
- "id": "string",
- "projectId": "string",
- "communityAllocationId": "string",
- "name": "string",
- "resourceTypeId": "string",
- "resourceUnit": "string",
- "siteId": "string",
- "siteName": "string",
- "serviceId": "string",
- "serviceName": "string",
- "amount": 0
}
]
Performs operation of accepting the policy on behalf of given user.
siteId required | string |
policyId required | string |
fenixUserId required | string |
[- {
- "fenixUserId": "string",
- "policyId": "string",
- "acceptanceStatus": "ACCEPTED",
- "processedOn": "2019-08-24T14:15:22Z",
- "currentPolicyRevision": 0,
- "acceptedRevision": 0
}
]
FURMS administration endpoint that provides comprehensive access to communities as well as exposes basic operations that can be done in the context of communities.
Creates a new group in a community.
communityId required | string |
name | string |
description | string |
{- "name": "string",
- "description": "string"
}
{- "id": "string",
- "name": "string",
- "description": "string"
}
Returns complete information about projects related to specific community.
communityId required | string |
[- {
- "id": "string",
- "acronym": "string",
- "name": "string",
- "communityId": "string",
- "researchField": "string",
- "installations": [
- {
- "siteId": "string",
- "gid": "string"
}
], - "description": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "projectLeader": {
- "fenixIdentifier": "string",
- "title": "string",
- "firstname": "string",
- "lastname": "string",
- "email": "string",
- "affiliation": {
- "name": "string",
- "email": "string",
- "country": "string",
- "postalAddress": "string"
}, - "nationality": "string",
- "phone": "string",
- "dateOfBirth": "2019-08-24",
- "placeOfBirth": "string",
- "postalAddress": "string"
}
}
]
Returns complete information about a group, including membership information.
communityId required | string |
groupId required | string |
{- "id": "string",
- "name": "string",
- "description": "string",
- "memberFenixUserIds": [
- "string"
]
}
Update mutable elements of a group.
communityId required | string |
groupId required | string |
name | string |
description | string |
{- "name": "string",
- "description": "string"
}
{- "id": "string",
- "name": "string",
- "description": "string"
}
Retrieve all allocations of a community.
communityId required | string |
[- {
- "id": "string",
- "name": "string",
- "creditId": "string",
- "resourceUnit": "string",
- "siteId": "string",
- "siteName": "string",
- "serviceId": "string",
- "serviceName": "string",
- "amount": 0
}
]
Create a new allocation for a community.
communityId required | string |
creditId | string |
name | string |
amount | number |
{- "creditId": "string",
- "name": "string",
- "amount": 0
}
[- {
- "id": "string",
- "name": "string",
- "creditId": "string",
- "resourceUnit": "string",
- "siteId": "string",
- "siteName": "string",
- "serviceId": "string",
- "serviceName": "string",
- "amount": 0
}
]
Retrieve a particular allocation of a community.
communityId required | string |
communityAllocationId required | string |
{- "id": "string",
- "name": "string",
- "creditId": "string",
- "resourceUnit": "string",
- "siteId": "string",
- "siteName": "string",
- "serviceId": "string",
- "serviceName": "string",
- "amount": 0
}
FURMS administration endpoint that provides comprehensive access to Projects as well as exposes basic operations that can be done in context of a Projects
Returns complete information about all projects including its allocations
[- {
- "id": "string",
- "acronym": "string",
- "name": "string",
- "communityId": "string",
- "researchField": "string",
- "installations": [
- {
- "siteId": "string",
- "gid": "string"
}
], - "description": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "projectLeader": {
- "fenixIdentifier": "string",
- "title": "string",
- "firstname": "string",
- "lastname": "string",
- "email": "string",
- "affiliation": {
- "name": "string",
- "email": "string",
- "country": "string",
- "postalAddress": "string"
}, - "nationality": "string",
- "phone": "string",
- "dateOfBirth": "2019-08-24",
- "placeOfBirth": "string",
- "postalAddress": "string"
}
}
]
Creates project under particular community.
communityId | string |
acronym | string |
gid | string |
name | string |
description | string |
object (Validity) | |
researchField | string |
projectLeaderId | string |
{- "communityId": "string",
- "acronym": "string",
- "gid": "string",
- "name": "string",
- "description": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "researchField": "string",
- "projectLeaderId": "string"
}
{- "id": "string",
- "acronym": "string",
- "name": "string",
- "communityId": "string",
- "researchField": "string",
- "installations": [
- {
- "siteId": "string",
- "gid": "string"
}
], - "description": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "projectLeader": {
- "fenixIdentifier": "string",
- "title": "string",
- "firstname": "string",
- "lastname": "string",
- "email": "string",
- "affiliation": {
- "name": "string",
- "email": "string",
- "country": "string",
- "postalAddress": "string"
}, - "nationality": "string",
- "phone": "string",
- "dateOfBirth": "2019-08-24",
- "placeOfBirth": "string",
- "postalAddress": "string"
}
}
Returns complete information about project including its allocations and its members.
projectId required | string |
{- "project": {
- "id": "string",
- "acronym": "string",
- "name": "string",
- "communityId": "string",
- "researchField": "string",
- "installations": [
- {
- "siteId": "string",
- "gid": "string"
}
], - "description": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "projectLeader": {
- "fenixIdentifier": "string",
- "title": "string",
- "firstname": "string",
- "lastname": "string",
- "email": "string",
- "affiliation": {
- "name": "string",
- "email": "string",
- "country": "string",
- "postalAddress": "string"
}, - "nationality": "string",
- "phone": "string",
- "dateOfBirth": "2019-08-24",
- "placeOfBirth": "string",
- "postalAddress": "string"
}
}, - "userFenixUserIds": [
- "string"
]
}
Update particular project.
projectId required | string |
name | string |
description | string |
object (Validity) | |
researchField | string |
projectLeaderId | string |
{- "name": "string",
- "description": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "researchField": "string",
- "projectLeaderId": "string"
}
{- "id": "string",
- "acronym": "string",
- "name": "string",
- "communityId": "string",
- "researchField": "string",
- "installations": [
- {
- "siteId": "string",
- "gid": "string"
}
], - "description": "string",
- "validity": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "projectLeader": {
- "fenixIdentifier": "string",
- "title": "string",
- "firstname": "string",
- "lastname": "string",
- "email": "string",
- "affiliation": {
- "name": "string",
- "email": "string",
- "country": "string",
- "postalAddress": "string"
}, - "nationality": "string",
- "phone": "string",
- "dateOfBirth": "2019-08-24",
- "placeOfBirth": "string",
- "postalAddress": "string"
}
}
Retrieve all project's allocations information
projectId required | string |
[- {
- "id": "string",
- "projectId": "string",
- "communityAllocationId": "string",
- "name": "string",
- "resourceTypeId": "string",
- "resourceUnit": "string",
- "siteId": "string",
- "siteName": "string",
- "serviceId": "string",
- "serviceName": "string",
- "amount": 0
}
]
Allocate resources to a project.
projectId required | string |
communityAllocationId | string |
communityId | string |
name | string |
resourceTypeId | string |
amount | number |
{- "communityAllocationId": "string",
- "communityId": "string",
- "name": "string",
- "resourceTypeId": "string",
- "amount": 0
}
[- {
- "id": "string",
- "projectId": "string",
- "communityAllocationId": "string",
- "name": "string",
- "resourceTypeId": "string",
- "resourceUnit": "string",
- "siteId": "string",
- "siteName": "string",
- "serviceId": "string",
- "serviceName": "string",
- "amount": 0
}
]
Retrieve project's allocation information
projectId required | string |
projectAllocationId required | string |
{- "id": "string",
- "projectId": "string",
- "communityAllocationId": "string",
- "name": "string",
- "resourceTypeId": "string",
- "resourceUnit": "string",
- "siteId": "string",
- "siteName": "string",
- "serviceId": "string",
- "serviceName": "string",
- "amount": 0
}