Users

Fetch User

Fetch data about the specified user.

Note: Requires administrator permissions to access other users data.

get/_api/user/{user}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/user/:user/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userstring string required

The id of the user.

Response

Successfully fetched data.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. Falsefor this response.

tenantstring

The name of the tenant.

userstring

The id of the user.

displayNamestring

The username of the tenant.

emailstring

The email of this API key.

activeboolean

Active status the API key.

extraobject

A JSON object with extra user information.

Example response

{
  "code": 200,
  "tenant": "_mm",
  "user": "Ugr0xjYMS9y0eN5gBxSSmg",
  "displayName": "test1",
  "email": "test@foo.com",
  "active": true,
  "apikey": {
    "hash": "1467ad2eed8e823f5a5db74aacd716d2f87dc3dde2bced8799e3c07dcf1c88ee",
    "parent": "root"
  },
  "extra": {}
}

Changes

No recorded changes to this operation across all 1 revision of this API.