Get User by Username

GET 
/org/:orgId/username/:username

Lists the user details for the user

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

username stringrequired

The username of the user for which you are querying.

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "user": {
      "user_id": "83cc05ae-7ebd-4c69-5f37-b39e718a7d80",
      "name": "testuser_dc",
      "email": "testuser@atscale.com",
      "auth_username": "testuser_dc",
      "super_user": false,
      "api_super_user": false,
      "roles": null
    },
    "organization": {
      "id": "default",
      "name": "default"
    }
  }
}

Example

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "user": {
      "user_id": "83cc05ae-7ebd-4c69-5f37-b39e718a7d80",
      "name": "testuser_dc",
      "email": "testuser@atscale.com",
      "auth_username": "testuser_dc",
      "super_user": false,
      "api_super_user": false,
      "roles": null
    },
    "organization": {
      "id": "default",
      "name": "default"
    }
  }
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if the org identified by orgId does not exist, or the user identified by username does not exist.

500

A server error occurred. Check the logs for more details.

Loading...