Documentation Powered by ReDoc

FURMS REST API (1.0.0)

Download OpenAPI specification:Download

License: BSD

Authentication

CIdP token

Pre-shared secret between Fenix central IdP and FURMS shall be used for authentication and authorization of each request with HTTP Basic encoding in HTTP header

Security Scheme Type HTTP
HTTP Authorization Scheme BASIC

FURMS API token

Pre-shared token generated by FURMS shall be used for authentication and authorization of each request

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Central IdP Endpoint

API intended for use by Fenix Central IdP, providing access to FURMS user attributes and basic user management.

Retrieve user attributes

Returns a complete information about a given user, including project membership and global attributes.

Authorizations:
CIdP token
path Parameters
fenixUserId
required
string

Responses

Response samples

Content type
application/json
{
  • "userStatus": "ENABLED",
  • "attributes": [
    ],
  • "communities": [
    ]
}

Get user status

Authorizations:
CIdP token
path Parameters
fenixUserId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "ENABLED"
}

Set user status

Authorizations:
CIdP token
path Parameters
fenixUserId
required
string
Request Body schema: application/json
status
string
Enum: "ENABLED" "DISABLED"

Responses

Request samples

Content type
application/json
{
  • "status": "ENABLED"
}