Update a trusted OpenID Connect Identity Provider for an App

patch

https://Use API Lookup for a base URL/apps/{app}/identityProviders/{identityProvider}

Update a trusted OpenID Connect Identity Provider for an App.

Access Control:

The calling principal must either have "manage" action permission for the resource "{app}" in the "account" service, and that the App is constrained to a Project or have "readIdentityProviders" action permission for the callers "{realm}" in the "account" service.
The calling principal MUST NOT include a project scope.

Path Params

app

string

required

HRN identifying the application. Must be URL-encoded, if reserved characters ":/?#[]@!$&'()*+,;=" are used. see https://tools.ietf.org/html/rfc3986#section-2.2.

identityProvider

string

required

HRN identifying the IdentityProvider.

Query Params

fields

string

Comma-separated list of fields to return, for each AppIdentityProviderAttachment.
By default, the "identityProviderHrn", "appHrn", and "enabled" properties are returned. Additional supported fields also include "identityProviderId", "identityProviderName", "identityProviderDescription", "identityProviderAccountType", "identityProviderRealm", and "identityProviderIssuers".

Body Params

enabled

boolean

Defaults to true

Indicates whether or not this AppIdentityProviderAttachment is enabled.

Headers

X-Request-ID

string

The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services.

X-Correlation-ID

string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response.

Responses

200OK

400Bad Request. E110000 - Missing required field, etc.

401Missing Authorization header.

403An error has occurred. E110000 - Subject does not have the required "manage" access to the app, or does not have the required "readIdentityProviders" access to the realm.