Show Source

• attributes: array attributes
  Optional fields for entities.
• entityType(required): string
  Allowed Values: [ "IDENTITY_GROUP", "GROUP", "META_POLICY", "TARGET_POLICY", "PM_ROLE", "ROLE", "ORGANIZATION", "IDENTITY_COLLECTION", "TARGET", "CLOUD_ACCOUNT", "APPLICATION", "RESOURCES", "PERMISSIONS", "PERMISSION_ASSIGNMENTS", "PERMISSION_TYPE", "ACCOUNT", "POLICY", "IDENTITY", "RESOURCE_ENTITY", "RESOURCE", "PERMISSION_COLLECTION", "PERMISSION_REQUEST", "GLOBAL_IDENTITY_COLLECTION", "AG_ORGANIZATION", "ACTIVE_GROUP", "CONSUMER_GROUP", "ACCESS_BUNDLE", "CLOUD_RESOURCE", "USER", "WORKLOAD", "ACCESS_GUARDRAIL" ]

  The Source Entity Type in Access Governance.
• id(required): string
  The Id for the Access Governance Entity.
• name(required): string
  The Name for the Access Governance Type.
• timeCreated(required): string(date-time)
  Time when the Access Bundle was created. An RFC3339 formatted datetime string.
• timeUpdated(required): string(date-time)
  Time when the Access Bundle was last updated. An RFC3339 formatted datetime string.
• type(required): string
  Allowed Values: [ "IDENTITY", "IDENTITY_COLLECTION", "ORGANIZATION", "ROLE", "PERMISSION", "ACCESS_BUNDLE", "POLICY", "RESOURCE", "CLOUD_RESOURCE", "ACCOUNT", "OWNERSHIP", "APPROVAL_PROCESS", "TARGET", "ACCESS_GUARDRAIL" ]

  The Access Governance Entity Type.
• typeDetails: string
  A resource that describes the type schema.
• value(required): string
  The json schema for the Access Governance Type.

{
    "type":"object",
    "required":[
        "entityType",
        "id",
        "name",
        "timeCreated",
        "timeUpdated",
        "type",
        "value"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Id for the Access Governance Entity."
        },
        "type":{
            "type":"string",
            "description":"The Access Governance Entity Type.",
            "enum":[
                "IDENTITY",
                "IDENTITY_COLLECTION",
                "ORGANIZATION",
                "ROLE",
                "PERMISSION",
                "ACCESS_BUNDLE",
                "POLICY",
                "RESOURCE",
                "CLOUD_RESOURCE",
                "ACCOUNT",
                "OWNERSHIP",
                "APPROVAL_PROCESS",
                "TARGET",
                "ACCESS_GUARDRAIL"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityType"
        },
        "name":{
            "type":"string",
            "description":"The Name for the Access Governance Type."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was created. An RFC3339 formatted datetime string."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Access Bundle was last updated. An RFC3339 formatted datetime string."
        },
        "entityType":{
            "type":"string",
            "description":"The Source Entity Type in Access Governance.",
            "enum":[
                "IDENTITY_GROUP",
                "GROUP",
                "META_POLICY",
                "TARGET_POLICY",
                "PM_ROLE",
                "ROLE",
                "ORGANIZATION",
                "IDENTITY_COLLECTION",
                "TARGET",
                "CLOUD_ACCOUNT",
                "APPLICATION",
                "RESOURCES",
                "PERMISSIONS",
                "PERMISSION_ASSIGNMENTS",
                "PERMISSION_TYPE",
                "ACCOUNT",
                "POLICY",
                "IDENTITY",
                "RESOURCE_ENTITY",
                "RESOURCE",
                "PERMISSION_COLLECTION",
                "PERMISSION_REQUEST",
                "GLOBAL_IDENTITY_COLLECTION",
                "AG_ORGANIZATION",
                "ACTIVE_GROUP",
                "CONSUMER_GROUP",
                "ACCESS_BUNDLE",
                "CLOUD_RESOURCE",
                "USER",
                "WORKLOAD",
                "ACCESS_GUARDRAIL"
            ],
            "x-obmcs-top-level-enum":"#/definitions/SourceEntityTypes"
        },
        "typeDetails":{
            "type":"string",
            "description":"A resource that describes the type schema."
        },
        "attributes":{
            "type":"array",
            "description":"Optional fields for entities.",
            "items":{
                "$ref":"#/definitions/AttributeOptionalField"
            }
        },
        "value":{
            "type":"string",
            "description":"The json schema for the Access Governance Type."
        }
    },
    "description":"The Access Governance Entity."
}

Show Source

• Array of: object AttributeOptionalField
  An optional Attribute field.

{
    "type":"array",
    "description":"Optional fields for entities.",
    "items":{
        "$ref":"#/definitions/AttributeOptionalField"
    }
}

Show Source

• name: string
  name of the field.
• value: object value
  Value of the field.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name of the field."
        },
        "value":{
            "type":"object",
            "description":"Value of the field.",
            "properties":{
            }
        }
    },
    "description":"An optional Attribute field."
}

Show Source

{
    "type":"object",
    "description":"Value of the field.",
    "properties":{
    }
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}