PUT | /api/idpx/{IdPxGuid} | Update the pattern and/or the parameters of id proxy configuration. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IdPxGuid | path | Guid | Yes | |
IdProviderGuid | body | Guid | No | |
Name | body | String | No | |
Description | body | String | No | |
Pattern | body | String | No | e.g., {"emailAddress": ".*@domain.com", "usrGroupName": "Name", "userGroupType": "Guest"} |
Parameters | body | String | No | e.g., {"language": "en", "userGroupType": "Professional"} |
TypeGuid | body | Guid | No | If it's empty, the Idpx record is going to use the Authentication workflow by default |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/idpx/{IdPxGuid} HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"idPxGuid": "00000000000000000000000000000000",
"idProviderGuid": "00000000000000000000000000000000",
"name": "String",
"description": "String",
"pattern": "String",
"parameters": "String",
"typeGuid": "00000000000000000000000000000000"
}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }