EntityInfo

Contains details about the specified entity (user or role).

This data type is an element of the EntityDetails object.

APIs.ioEngineeringPlatform

Properties

Name Type Description
Arn object
Name object
Type object
Id object
Path object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-entityinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EntityInfo",
  "title": "EntityInfo",
  "type": "object",
  "required": [
    "Arn",
    "Name",
    "Type",
    "Id"
  ],
  "properties": {
    "Arn": {
      "$ref": "#/components/schemas/arnType"
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/userNameType"
        },
        {
          "description": "The name of the entity (user or role)."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/policyOwnerEntityType"
        },
        {
          "description": "The type of entity (user or role)."
        }
      ]
    },
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/idType"
        },
        {
          "description": "The identifier of the entity (user or role)."
        }
      ]
    },
    "Path": {
      "allOf": [
        {
          "$ref": "#/components/schemas/pathType"
        },
        {
          "description": "The path to the entity (user or role). For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM identifiers</a> in the <i>IAM User Guide</i>. "
        }
      ]
    }
  },
  "description": "<p>Contains details about the specified entity (user or role).</p> <p>This data type is an element of the <a>EntityDetails</a> object.</p>"
}