REST API - list

esx authentication trust security token issuers: list

List the available security token issuer trusts.

Request:

HTTP request

GET https://{server}/api/esx/authentication/trust/security-token-issuers

?projection={value}

Query Parameters:

Name Type Description
bold = required
projection string Optional. The type of the returned summary - brief, normal or full.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "issuer_alias""obj-103",
        "signing_cert_chains"[
            {
                "cert_chain"[
                    "string",
                    "string"
                ]
            },
            {
                "cert_chain"[
                    "string",
                    "string"
                ]
            }
        ],
        "summary_type""FULL",
        "issuer""string"
    },
    {
        "issuer_alias""obj-103",
        "signing_cert_chains"[
            {
                "cert_chain"[
                    "string",
                    "string"
                ]
            },
            {
                "cert_chain"[
                    "string",
                    "string"
                ]
            }
        ],
        "summary_type""FULL",
        "issuer""string"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] The list of the current security token issuer trusts.
-[].summary_type string Defines the verbosity of the sumary.

Defines the types of esx.authentication.trust.security_token_issuers.summary members to return from the list method.

The profile information could include the access grants or be a shorter summary.

Value is one of:
FULL: The full security token isuer information, including certificates.
NORMAL: A summary containing only the security token issuer alias and the issuer string.
BRIEF: A brief summary, containing only the security token issuer alias.
-[].issuer_alias string The security token issuer trust identifier.

Optional. It is only relevant when summary_type has value [BRIEF, NORMAL, FULL]. This field is optional and it is only relevant when the value of summary_type is one of BRIEF, NORMAL, or FULL.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.authentication.trust.security-token-issuer. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.authentication.trust.security-token-issuer.

-[].issuer string Who created and signed the security token.

Optional. It is only relevant when summary_type has value [NORMAL, FULL]. This field is optional and it is only relevant when the value of summary_type is one of NORMAL or FULL.

-[].signing_cert_chains x509_cert_chain[] Token signing certificate chains.

These certificate chains are used only for verifying existing tokens and not for issuing new tokens on behalf of the external security token issuer.

Optional. It is only relevant when summary_type has value FULL. This field is optional and it is only relevant when the value of summary_type is FULL.

-[].signing_cert_chains[].cert_chain string[] Certificate chain in base64 format

Errors:

HTTP Status Code Type Description
500 error if there is a problem accessing the stored data.
400 invalid_argument if the projection argument contains invalid data.
401 unauthenticated if the user can not be authenticated.