Patch
Patch an IDP instance
Request
URI
PATCH
https://{api_host}/tca/tenancy/api/v1/idps/{idpId}
COPY
Path Parameters
string
idpId
Required
The identifier of the IDP
idpId example
fc0a0058-3cfd-44b1-a91d-5110d48a63e2
Header Parameters
boolean
trust-tls
Optional
If true then the certificate is imported into the trust store
trust-tls example
true
Request Body
IdpPatchBase of type(s) application/json
Required
This request body class requires all of the following: IdpPatchRoot
{
"name": "My IDP 1",
"description": "IDP using VMware SSO",
"type": "VC"
}
Responses
200
Successfully updated IDP
Returns IdpBase of type(s) application/json
This response body class contains all of the following: IdpRoot , InlineIdpBase1
{
"name": "My IDP 1",
"description": "IDP using VMware SSO",
"type": "VC",
"id": "fc0a0058-3cfd-44b1-a91d-5110d48a63e2",
"createdAt": "2023-02-13T13:19:37.448Z",
"creationUser": "[email protected]",
"links": {
"self": {
"href": "/telco/admin/api/idps/v1/idp/fc0a0058-3cfd-44b1-a91d-5110d48a63e2"
},
"update": {
"href": "/telco/admin/api/idps/v1/idp/fc0a0058-3cfd-44b1-a91d-5110d48a63e2"
},
"delete": {
"href": "/telco/admin/api/idps/v1/idp/fc0a0058-3cfd-44b1-a91d-5110d48a63e2"
}
}
}
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
500
Returns InternalServerError of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}