OpenAPI definition (v0)

Download OpenAPI specification:Download

policy-management-controller

Service to get policies

Responses

Service to create a new auth/datashare/ credential policy

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PolicyCreateRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"policyId": "string",
"policyGroupName": "string",
"policyType": "string",
"name": "string",
"desc": "string",
"version": "string",
"policies": {"empty": true,
"property1": { },
"property2": { }
}
}
}

Service to get policy

path Parameters

policyId

required

string

Responses

Service to update policy details

path Parameters

policyId

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PolicyUpdateRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"policyGroupName": "string",
"name": "string",
"desc": "string",
"policies": {"empty": true,
"property1": { },
"property2": { }
},
"version": "string"
}
}

Service to get policy for given partner and policy id

path Parameters

partnerId required	string
policyId required	string

Responses

Service to update policy status

path Parameters

policygroupId required	string
policyId required	string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PolicyStatusUpdateRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"status": "string"
}
}

Service to publish policy

path Parameters

policygroupId required	string
policyId required	string

Responses

Service to search policy

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PolicySearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"values": ["string"
],
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"policyType": "string"
}
}

Service to get policy group

path Parameters

policygroupId

required

string

Responses

Service to update a policy group

path Parameters

policygroupId

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PolicyGroupUpdateRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"name": "string",
"desc": "string",
"isActive": true
}
}

Service to search policy group

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SearchDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"values": ["string"
],
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
}
}
}

Service to create a new policy group

Service to craete a new policy group

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PolicyGroupCreateRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"name": "string",
"desc": "string"
}
}

Service to filter policy groups

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (FilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"optionalFilters": [{"value": "string",
"values": ["string"
],
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

Service to get all policy groups

Service to all policy groups

Responses

Service to filter policy details

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PolicyFilterValueDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"optionalFilters": [{"value": "string",
"values": ["string"
],
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"policyType": "string"
}
}

Service to get value for a given config key

path Parameters

key

required

string

Responses

Service to get active policy details for policy group name

path Parameters

groupName

required

string

Home

OpenAPI definition (v0)

policy-management-controller

Service to get policies

Responses

Service to create a new auth/datashare/ credential policy

Request Body schema: application/json

Responses

Request samples

Service to get policy

path Parameters

Responses

Service to update policy details

path Parameters

Request Body schema: application/json

Responses

Request samples

Service to get policy for given partner and policy id

path Parameters

Responses

Service to update policy status

path Parameters

Request Body schema: application/json

Responses

Request samples

Service to publish policy

path Parameters

Responses

Service to search policy

Request Body schema: application/json

Responses

Request samples

Service to get policy group

path Parameters

Responses

Service to update a policy group

path Parameters

Request Body schema: application/json

Responses

Request samples

Service to search policy group

Request Body schema: application/json

Responses

Request samples

Service to create a new policy group

Request Body schema: application/json

Responses

Request samples

Service to filter policy groups

Request Body schema: application/json

Responses

Request samples

Service to get all policy groups

Responses

Service to filter policy details

Request Body schema: application/json

Responses

Request samples

Service to get value for a given config key

path Parameters

Responses

Service to get active policy details for policy group name

path Parameters

Responses

Home