Name | Description | Type | Notes |
---|---|---|---|
_create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
_create_user | ID of the user who created this resource | string | Readonly |
_last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
_last_modified_user | ID of the user who last modified this resource | string | Readonly |
_links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
_protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
_revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
_schema | Schema for this resource | string | Readonly |
_self | Link to this resource | SelfResourceLink | Readonly |
_system_owned | Indicates system owned resource | boolean | Readonly |
certificate_id | Id of the stored certificate Id of the stored certificate. When used with the deprecated POST /trust-management/principal-identities API this field is required. |
string | |
certificate_pem | PEM encoding of the new certificate PEM encoding of the new certificate. |
string | Required |
description | Description of this resource | string | Maximum length: 1024 Sortable |
display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
id | Unique identifier of this resource | string | Sortable |
is_protected | Protection indicator Indicator whether the entities created by this principal should be protected. |
boolean | |
name | Name Name of the principal. |
string | Required Maximum length: 255 Pattern: "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$" |
node_id | Unique node-id Unique node-id of a principal. |
string | Required Maximum length: 255 Pattern: "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$" |
permission_group | permission group Use the 'role' field instead and pass in 'auditor' for read_only_api_users or 'enterprise_admin' for the others. |
UserGroupType | Deprecated |
resource_type | Must be set to the value PrincipalIdentityWithCertificate | string | |
role | Role | string | Pattern: "^[a-zA-Z]+(_?[a-zA-Z]+)*$" |
tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |