Configure token exchange trust

Establishes a trust relationship between the Ops Manager UAA and a remote Hub UAA for RFC 8693 token exchange. Ops Manager discovers the Hub UAA issuer via its OIDC discovery endpoint, persists the configuration, and applies it to the running UAA over UAA's identity provider API.

This endpoint is idempotent and never restarts UAA: resubmitting a configuration that is already in effect leaves the same configuration in effect, and every field, including hub_uaa_ca_cert, is applied to the running UAA immediately.

Request

URI

PUT

https://{opsmanager-installation}/api/v0/uaa/token_exchange_trust

COPY

Request Body

TokenExchangeTrustRequest of type(s) application/json

Required

{
    "token_exchange_trust": {
        "hub_uaa_url": "string",
        "hub_uaa_ca_cert": "string",
        "origin_mappings": [
            {
                "external_origin": "string",
                "local_origin": "string"
            }
        ]
    }
}

token_exchange_trust

Optional

token_exchange_trust

Responses

200

Returns TokenExchangeTrust of type(s) application/json

{
    "token_exchange_trust": {
        "hub_uaa_url": "string",
        "hub_uaa_issuer": "string",
        "origin_mappings": [
            {
                "external_origin": "string",
                "local_origin": "string"
            }
        ],
        "configured": false
    }
}

token_exchange_trust

Optional

token_exchange_trust

400

Setup is not completed

Returns RequireSetupCompleted of type(s) application/json

{
    "errors": {
        "errors": [
            "string"
        ]
    }
}

object

errors

Optional

errors

401

Unauthorized

Returns UnauthorizedResponse of type(s) application/json

{
    "errors": {
        "errors": [
            "string"
        ]
    }
}

object

errors

Optional

errors

403

Forbidden

Returns ForbiddenResponse of type(s) application/json

{
    "errors": {
        "errors": [
            "string"
        ]
    }
}

object

errors

Optional

errors

422

Unprocessable Content

Returns CommonErrors of type(s) application/json

{
    "errors": [
        "string"
    ]
}

array of string

errors

Required

errors

502

The configuration could not be applied to UAA, nothing was saved, and the request can be retried

Returns CommonErrors of type(s) application/json

{
    "errors": [
        "string"
    ]
}

array of string

errors

Required

errors

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v0/uaa/token_exchange_trust

On This Page

Description

Request

Request Body

Response

200 Response Body

Errors

Uaa Settings Operations

GET

Viewing UAA password policy

PUT

Update UAA password policy