CCC API v8.4.0.0

CreateServiceIdPx

The following routes are available for this service:
POST	/api/services/{ServiceGuid}/idpx	Add identity proxy configuration for the specified service.

**CreateServiceIdPx** Parameters:
Name	Parameter	Data Type	Required	Description
ServiceGuid	path	Guid	Yes
IdProviderGuid	body	Guid	No
Pattern	body	String	No	e.g., {"emailAddress": ".*@domain.com", "usrGroupName": "Name", "userGroupType": "Guest"}
Parameters	body	String	No	e.g., {"language": "en", "userGroupType": "Professional"}
Name	body	String	No
Description	body	String	No
TypeGuid	body	Guid	No	If it's empty, the Idpx record is going to use the Authentication workflow by default

**CreateServiceIdPxResponse** Parameters:
Name	Parameter	Data Type	Required	Description
IdPxGuid	body	Guid	No

**BaseResponse** Parameters:
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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/services/{ServiceGuid}/idpx HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "serviceGuid": "00000000000000000000000000000000",
  "idProviderGuid": "00000000000000000000000000000000",
  "pattern": "String",
  "parameters": "String",
  "name": "String",
  "description": "String",
  "typeGuid": "00000000000000000000000000000000"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "idPxGuid": "00000000000000000000000000000000",
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}