Endpoint | HTTP Verb | Description | Request Schema | Response Schema (Success) |
|---|
v2/claimSets | GET | Retrieves all claimsets | - | [
{
"id": 0,
"name": "string",
"_isSystemReserved": true,
"_applications": []
}
] |
|---|
v2/claimSets | POST | Creates a new claimset. | { "name": "string"} | {
"id": 0,
"name": "string",
"_isSystemReserved": false,
"_applications": []
}
|
|---|
v2/claimSets/{id} | GET | Retrieves a specific claimset by id | - | {
"id": 0,
"name": "string",
"_isSystemReserved": false,
"_applications": [],
"resourceClaims": [
{
"id": "string",
"name": "string",
"read": true,
"create": true,
"update": true,
"delete": true,
"_defaultAuthStrategiesForCRUD": [
{
"actionName": string,
"authStrategies": [],
"isInheritedFromParent": true
}
],
"authStrategyOverridesForCRUD": [
{
"actionName": string,
"authStrategies": [],
"isInheritedFromParent": true
}
],
"children": [
"list of resource claims"
]
}
]
} |
|---|
v2/claimSets/{id} | PUT | Update the claim set name. | {
"id": 0,
"name": "string"
} | HTTP response as documented below |
|---|
v2/claimSets/{id} | DELETE | Deletes a claimset by id | - | HTTP response as documented below |
|---|
v2/claimSets/{claimSetId}/resourceClaimActions | POST | Add resourceclaimaction association to claim set. At least one action should be enabled (read, create, update, delete).
resouceclaimId is required fields.
| {
"resouceclaimId" : 0,
"resourceClaimActions":
{
"read": true,
"create": true,
"update": true,
"delete": true
}
} | HTTP response as documented below |
|---|
v2/claimSets/{claimSetId}/
resourceClaimActions/{resourceClaimid}
| PUT | Updates the resourceclaimActions to a specific resource claim on a claimset. At least one action should be enabled (read, create, update, delete). | {
"resourceClaimActions":
{
"read": true,
"create": true,
"update": true,
"delete": true
}
} | HTTP response as documented below |
|---|
v2/claimSets/{claimSetId}/resourceClaimActions/
{resourceClaimId}/overrideAuthStrategy
| POST | Override the default authorization strategies on provided resource claim for a specific action. ex: actionName = read, authstrategyName=Ownershipbased | {
"actionName": string,
"authstrategyName: string
} | HTTP response as documented below |
|---|
v2/claimSets/{claimSetId}/resourceClaimActions/
{resourceClaimId}/resetAuthStrategies
| POST | Reset to default authorization strategies on provided resource claim. | - | HTTP response as documented below |
|---|
v2/claimSets/{claimSetId}/
resourceClaimActions/{resourceClaimId} | DELETE | Deletes a resource claims association from a claim set | - | HTTP response as documented below |
|---|
v2/claimSets/copy | POST | Copy the existing claimset and create new. | {
"originalId": 0,
"name": "string"
} | HTTP response as documented below
|
|---|
| v2/claimSets/import | POST | Import new claimset | {
"name": "string",
"resourceClaims": [
{
"name": "string",
"read": true,
"create": true,
"update": true,
"delete": true,
"authStrategyOverridesForCRUD": [
{
"actionName": string,
"authStrategies": []
}
],
"children": [
"list of resource claims"
]
}
]
} | HTTP response as documented below |
|---|