NSX-T Data Center REST API

OidcEndPoint (type)

{
  "additionalProperties": false, 
  "description": "OpenID Connect end-point specifying where to fetch the JWKS document used to validate JWT tokens for TokenBasedPrincipalIdentities.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "OidcEndPoint", 
  "module_id": "CertificateManager", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "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.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "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.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "authorization_endpoint": {
      "description": "The URL of the OpenID provider's authorization endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Authorization endpoint", 
      "type": "string"
    }, 
    "claims_supported": {
      "description": "The list of claims that the OpenID provider supports.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Claims supported", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "issuer": {
      "description": "Issuer of the JWT tokens for the given type. This field is fetched from the meta-data located at the oidc_uri.", 
      "readonly": true, 
      "required": false, 
      "title": "JWT token issuer", 
      "type": "string"
    }, 
    "jwks_uri": {
      "description": "The URI where the JWKS document is located that has the key used to validate the JWT signature.", 
      "readonly": true, 
      "required": false, 
      "title": "URI of JWKS document", 
      "type": "string"
    }, 
    "name": {
      "description": "A short, unique name for this OpenID Connect end-point. OIDC endpoint names may not contain spaces. If not provided, defaults to the ID of the OidcEndPoint.", 
      "required": false, 
      "title": "Unique name for this OpenID Connect end-point", 
      "type": "string"
    }, 
    "oidc_type": {
      "default": "vcenter", 
      "description": "Type used to distinguish the OIDC end-points by IDP.", 
      "enum": [
        "vcenter", 
        "ws_one"
      ], 
      "maxLength": 255, 
      "readonly": false, 
      "required": false, 
      "title": "OIDC Type", 
      "type": "string"
    }, 
    "oidc_uri": {
      "description": "URI of the OpenID Connect end-point.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "OpenID Connect URI", 
      "type": "string"
    }, 
    "override_roles": {
      "description": "When specified this role or roles are used instead of the nsx-role in the JWT", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Roles used instead of token roles", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "thumbprint": {
      "description": "Thumbprint in SHA-256 format used to verify the server certificate at the URI.", 
      "maxLength": 255, 
      "readonly": false, 
      "required": true, 
      "title": "Thumbprint", 
      "type": "string"
    }, 
    "token_endpoint": {
      "description": "The URL of the OpenID provider's token endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Token endpoint", 
      "type": "string"
    }, 
    "userinfo_endpoint": {
      "description": "The URL of the OpenID provider's userinfo endpoint.", 
      "readonly": true, 
      "required": false, 
      "title": "Userinfo endpoint", 
      "type": "string"
    }
  }, 
  "title": "OpenID Connect end-point", 
  "type": "object"
}