IBM API Hub
Maximo Application Suite Admin APIs 9.0.x

By IBM Maximo

Provides REST APIs for performing Suite administration operations.


API reference

Add new user

POST

/v3/users

Requires User Administration permission

Request URL
https://api.{mas-instance-id}.{mas-domain}/v3/users?emailPassword=REPLACE_THIS_VALUE&validate=REPLACE_THIS_VALUE
Security
apiKey
x-access-token
required in header
Parameters
Name
Description
  • emailPassword
    boolean
    (query)

    if true, user will be sent an an email containing their password

  • validate
    boolean
    (query)

    if true, just validate user input without creating user

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

      User profile

    • 400

      Bad Request

    • 401

      Authentication token is empty or invalid

    • 403

      Authenticated user is not permitted to make the request

    • 409

      Conflict Response:

    • 500

      An internal server error occured

    Code snippet
      1curl --request POST \
      2  --url 'https://api.replace_mas-instance-id_variable.replace_mas-domain_variable/v3/users?emailPassword=REPLACE_THIS_VALUE&validate=REPLACE_THIS_VALUE' \
      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": "joebloggs",
          3  "status": {
          4    "active": true,
          5    "activationUpdateReason": "account creation",
          6    "expiresAt": "2023-05-15T00:00:00",
          7    "inactivityTimeout": "P1W",
          8    "activationUpdateTimestamp": "2023-04-15T00:00:00",
          9    "lastActivityTimestamp": "2023-05-25T10:31:16"
          10  },
          11  "username": "joebloggs",
          12  "emails": [
          13    {
          14      "value": "john.doe@example.com",
          15      "type": "work",
          16      "primary": true
          17    }
          18  ],
          19  "phoneNumbers": [
          20    {
          21      "value": "555-555-5555",
          22      "type": "work",
          23      "primary": true
          24    }
          25  ],
          26  "addresses": [
          27    {
          28      "streetAddress": "100 Universal City Plaza",
          29      "locality": "Hollywood",
          30      "region": "CA",
          31      "postalCode": 91608,
          32      "country": "USA",
          33      "formatted": "100 Universal City Plaza\\nHollywood, CA 91608 USA",
          34      "primary": true
          35    }
          36  ],
          37  "givenName": "John",
          38  "familyName": "Doe",
          39  "displayName": "John Doe",
          40  "title": "Architect",
          41  "extension": {
          42    "id": 7721062796099584
          43  },
          44  "permissions": {
          45    "systemAdmin": true,
          46    "userAdmin": true,
          47    "apikeyAdmin": true
          48  },
          49  "entitlement": {
          50    "application": "BASE",
          51    "admin": "ADMIN_LIMITED",
          52    "alwaysReserveLicense": true
          53  },
          54  "version": 2,
          55  "owner": "local|scim",
          56  "groups": [
          57    {
          58      "circular_reference": "#/components/schemas/GroupList"
          59    }
          60  ],
          61  "added": {
          62    "id": "janedoe",
          63    "timestamp": "2020-02-20T13:54:00"
          64  },
          65  "updated": {
          66    "id": "janedoe",
          67    "timestamp": "2020-02-20T13:54:00"
          68  },
          69  "sync": {
          70    "status": "PENDING",
          71    "timestamp": "2020-02-20T13:54:00"
          72  },
          73  "applications": {
          74    "monitor": {
          75      "sync": {
          76        "state": "PENDING",
          77        "timestamp": "2020-02-20T13:54:00"
          78      }
          79    },
          80    "iot": {
          81      "sync": {
          82        "state": "PENDING",
          83        "timestamp": "2020-02-20T13:54:00"
          84      }
          85    },
          86    "health": {
          87      "sync": {
          88        "state": "PENDING",
          89        "timestamp": "2020-02-20T13:54:00"
          90      }
          91    },
          92    "predict": {
          93      "sync": {
          94        "state": "PENDING",
          95        "timestamp": "2020-02-20T13:54:00"
          96      }
          97    },
          98    "visualinspection": {
          99      "sync": {
          100        "state": "PENDING",
          101        "timestamp": "2020-02-20T13:54:00"
          102      }
          103    },
          104    "assist": {
          105      "sync": {
          106        "state": "PENDING",
          107        "timestamp": "2020-02-20T13:54:00"
          108      }
          109    }
          110  },
          111  "identities": {
          112    "_local": {
          113      "type": "local",
          114      "forceTokenChange": false,
          115      "state": {
          116        "failedLoginAttempts": 0,
          117        "lockedOut": false,
          118        "firstFailedLoginTimestamp": "2023-12-12T18:55:59.134777",
          119        "lockedOutStateChangeTimestamp": "2023-12-12T18:55:59.134777"
          120      }
          121    },
          122    "default-saml": {
          123      "type": "saml",
          124      "id": "joebloggs@ibm.com"
          125    },
          126    "default-ldap": {
          127      "type": "ldap",
          128      "id": "joebloggs@openldap.com"
          129    }
          130  },
          131  "preferences": {
          132    "locale": {
          133      "language": "en",
          134      "country": "GB"
          135    },
          136    "timezone": "Africa/Abidjan"
          137  },
          138  "selfReg": {
          139    "approved": true,
          140    "id": "masadmin",
          141    "appId": "core",...
          Example is truncated for better usability.
          To see the full example, use the Copy button to copy it to the clipboard.