NSX-T Data Center REST API

Get a principal identity

Get a stored principal identity

Request:

Method:

GET

URI Path(s):

/api/v1/trust-management/principal-identities/{principal-identity-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PrincipalIdentity+

PrincipalIdentity (schema)

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
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. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same 'name' is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.	string	Required Maximum length: 255 Pattern: "^[a-zA-Z0-9]+([-._]?[a-zA-Z0-9]+)*$"
resource_type	Must be set to the value PrincipalIdentity	string
role	Role The roles that are associated with this PI.	string	Deprecated Pattern: "^[_a-z0-9-]+$"
roles_for_paths	Roles for Paths The roles that are associated with this PI, limiting them to a policy path like '/infra'. In case the path is '/', the roles apply everywhere.	array of RolesForPath
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "id": "ebd3032d-728e-44d4-9914-d4f81c9972cb", "name": "open-stack", "node_id": "node-2", "roles_for_paths": [ { "path": "/", "roles": [ { "role": "network_engineer" } ] } ], "role": "network_engineer", "is_protected": "false", "certificate_id" : "abd3032d-728e-44d4-9914-d4f81c9972cc" }

NSX-T Data Center REST API

Get a principal identity

Request:

Successful Response:

PrincipalIdentity (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: