Sign in
management-requests

Find management requests

Changed on

List management requests

get/management-requests

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/management-requests
  • Auth: API key in header Authorization

Query parameters

querystring nullable

Free text query

origin'CENTER' | 'SECURITY_SERVER'

request source

typesManagementRequestType[] nullable

management request type

status'WAITING' | 'APPROVED' | 'DECLINED' | 'REVOKED' | 'SUBMITTED FOR APPROVAL'

request status

server_idstring nullable

security server id

optional filtering parameters. Filtering is possible according to one of the following values: <ul> <li><b>q</b> Free text query</li> <li><b>origin</b> Request origin</li> <li><b>type</b> an array of types</li> <li><b>serverId</b> Security server id</li>

</ul>
sortstring

Indicates item property that is to be used as sorting key.

descboolean

Used sorting direction. Value 'true' indicates descending and 'false' or omitted parameter indicates ascending direction.

limitinteger

Indicates the maximum number of items for the returned page. If parameter is omitted, then the default amount of 25 is returned.

offsetinteger

Offset in pages from the beginning of the query result after filtering and sorting parameters are taken into account. If the parameter omitted or the value 0 (zero) is given, the first page is returned.

optional paging and sorting parameters. Sorting possible according to one of the following values: <ul> <li><b>id</b> for id</li> <li><b>created_at</b> Creation date</li>

</ul>
{
  "sort": "title"
}

Response

array of management requests

Example response

{
  "items": [
    {
      "security_server_id": {
        "instance_id": "FI",
        "member_class": "GOV",
        "server_code": "server123"
      },
      "client_id": {
        "instance_id": "FI",
        "member_class": "GOV",
        "subsystem_code": "ABC"
      }
    }
  ]
}

Changes

  • 72c3c9c00de3Revision changes
    • ○

      mapped value for discriminator key MEMBER changed from ClientId to for ////// response property for the response status

    • ○

      mapped value for discriminator key MEMBER changed from ClientId to for ////// response property for the response status

    • ○

      mapped value for discriminator key SERVER changed from SecurityServerId to for ////// response property for the response status

    • ○

      mapped value for discriminator key SERVER changed from SecurityServerId to for ////// response property for the response status

    • ○

      mapped value for discriminator key SUBSYSTEM changed from ClientId to for ////// response property for the response status

    • ○

      mapped value for discriminator key SUBSYSTEM changed from ClientId to for ////// response property for the response status

  • 49854d95889cRevision changes
    • ▲

      the /////// response's property format changed from text§ to text for status

    • ▲

      the /////// response's property format changed from text§ to text for status