Successful Response

APIs.ioEngineeringPlatform

Properties

Name Type Description
user object Information about the authenticated user.
operations array Information about operations and their usage limits. This object does not return for users with the [Guest and Partner role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permis
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-getauthenticateduser-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/getAuthenticatedUser",
  "title": "Successful Response",
  "type": "object",
  "properties": {
    "user": {
      "type": "object",
      "description": "Information about the authenticated user.",
      "properties": {
        "id": {
          "type": "number",
          "description": "The user's Postman ID.",
          "example": 12345678
        },
        "username": {
          "type": "string",
          "description": "The user's username.",
          "example": "taylor-lee"
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "The user's email address.",
          "example": "[email protected]"
        },
        "fullName": {
          "type": "string",
          "description": "The user's full name.",
          "example": "Taylor Lee"
        },
        "avatar": {
          "type": "string",
          "format": "url",
          "nullable": true,
          "description": "The user's avatar image URL.",
          "example": "https://example.com/user/r5u9qpvmujfjf6lbqmga.jpg"
        },
        "isPublic": {
          "type": "boolean",
          "description": "If true, the user's information is public and visible to all users.",
          "example": true
        },
        "teamId": {
          "type": "integer",
          "description": "The team ID the user is assigned to. This returns a `0` value if the user is not assigned to a team.",
          "example": 123
        },
        "teamName": {
          "type": "string",
          "description": "The name of the team the user is assigned to.",
          "example": "Test Team"
        },
        "teamDomain": {
          "type": "string",
          "description": "The team's Postman domain ID.",
          "example": "test-team"
        },
        "roles": {
          "type": "array",
          "description": "A list of the user's assigned [roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).",
          "items": {
            "type": "string",
            "default": "user",
            "example": "user"
          }
        }
      }
    },
    "operations": {
      "type": "array",
      "description": "Information about operations and their usage limits. This object does not return for users with the [Guest and Partner role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).",
      "items": {
        "type": "object",
        "properties": {
          "limit": {
            "type": "number",
            "description": "The operation's limit value.",
            "example": 1000000
          },
          "name": {
            "type": "string",
            "description": "The operation's name.",
            "example": "mock_usage"
          },
          "overage": {
            "type": "number",
            "description": "The operation's overage value.",
            "example": 0
          },
          "usage": {
            "type": "number",
            "description": "The operation's current usage value.",
            "example": 110276
          }
        }
      }
    }
  }
}