Idps idp id

PATCH /v2/idps/{idp-id}

Request

curl --request PATCH \
  --url 'http://localhost:7575/v2/idps/{idp-id}' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"identityProviderConfig":{"identityProviderId":"string","isDeactivated":false,"issuer":"string","jwksUrl":"string","audience":"string"},"updateMask":{"paths":["string"],"unknownFields":{}}}'

200 response

{
  "identityProviderConfig": {
    "identityProviderId": "string",
    "isDeactivated": false,
    "issuer": "string",
    "jwksUrl": "string",
    "audience": "string"
  }
}

JSON Ledger API

Idps idp id

OpenAPIAdded 3.4Updated 3.5

Update selected modifiable attribute of an identity provider config resource described by the IdentityProviderConfig message.

Protocol Details

Operation IDpatchV2IdpsIdp-id

AuthenticationBearer token

Published3.5

Inputs

Path parameters

idp-id · string · required

Request body

application/json

identityProviderConfig · object · required

OpenAPI type: IdentityProviderConfig.

updateMask · object · required

OpenAPI type: FieldMask.

Outputs

200

application/json

identityProviderConfig · IdentityProviderConfig · required

400

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Updated3.5

The PATCH /v2/idps/{idp-id} operation was updated in this snapshot.

Added3.4

Request

curl --request PATCH \
  --url 'http://localhost:7575/v2/idps/{idp-id}' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"identityProviderConfig":{"identityProviderId":"string","isDeactivated":false,"issuer":"string","jwksUrl":"string","audience":"string"},"updateMask":{"paths":["string"],"unknownFields":{}}}'

200 response

{
  "identityProviderConfig": {
    "identityProviderId": "string",
    "isDeactivated": false,
    "issuer": "string",
    "jwksUrl": "string",
    "audience": "string"
  }
}