IBM API Hub
Maximo Application Suite Admin APIs 9.0.x

By IBM Maximo

Provides REST APIs for performing Suite administration operations.


API reference

Create an API Key

POST

/v1/apikeys

Requires API Key Administration permission

Request URL
https://api.{mas-instance-id}.{mas-domain}/v1/apikeys
Security
apiKey
x-access-token
required in header

A JWT obtained via an API Key authenticate request

Parameters
Name
Description
  • Content-type
    string
    (header)
    application/json
  • Accept
    string
    (header)
    application/json
  • Request body
    Responses
    • 201

      Details of the api key that was created.

      Note: The token field will only be returned in response to creating a new api key, or after the refresh of the api key token. It is not recoverable and should be safely recorded.

    • 400

      Bad Request

    • 401

      Authentication token is empty or invalid

    • 403

      Authenticated user is not permitted to make the request

    • 500

      An internal server error occured

    Code snippet
      1curl --request POST \
      2  --url https://api.replace_mas-instance-id_variable.replace_mas-domain_variable/v1/apikeys \
      3  --header 'accept: application/json' \
      4  --header 'content-type: application/json' \
      5  --header 'x-access-token: REPLACE_THIS_VALUE' \
      6  --data REPLACE_REQUEST_BODY
      

        Example response

          1{
          2  "id": "a-tenantid-cwhnvjqcgv",
          3  "version": 1,
          4  "status": {
          5    "active": true,
          6    "tokenRefreshInterval": "P1W"
          7  },
          8  "description": "API Key for user management automation",
          9  "permissions": {
          10    "systemAdmin": false,
          11    "userAdmin": true,
          12    "apikeyAdmin": false
          13  },
          14  "added": {
          15    "id": "leo.davison@uk.ibm.com",
          16    "timestamp": "2020-12-20T17:28:29.871Z"
          17  },
          18  "updated": {
          19    "id": "leo.davison@uk.ibm.com",
          20    "timestamp": "2000-05-31T15:31:45.295Z"
          21  },
          22  "token": "bHmYHLy&0r8on9S_YMS+Rx"
          23}