Manage PrivilegedData with SCIM endpoints

This topic provides examples of requests supported by the PrivilegedData endpoint.

Send requests to scim/PrivilegedData to manage Accounts in Privilege Cloud . This endpoint currently supports the following methods:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

Examples

GET all PrivilegedData

GET https://myTenant.idaptive.app/scim/PrivilegedData

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 2,
    "itemsPerPage": 2,
    "startIndex": 1,
    "Resources": [
        {
            "name": "myPrivilegeData",
            "type": "password",
            "schemas": [
                "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData",
                "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData"
            ],
            "id": "1",
            "meta": {
                "resourceType": "PrivilegedData",
                "created": "2021-03-24T16:23:24Z",
                "lastModified": "2021-03-24T16:23:24Z",
                "location": "https://mytenant.idaptive.app/scim/v2/PrivilegedData/1"
            },
            "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
                "safe": "myContainer",
                "properties": [
                    {
                        "key": "username",
                        "value": "user1"
                    },
                    {
                        "key": "address",
                        "value": "192.0.2.1"
                    },
                    {
                        "key": "platformId",
                        "value": "WinDesktopLocal"
                    }
                ]
            }
        },
        {
            "name": "myPrivilegeData2",
            "type": "password",
            "schemas": [
                "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData",
                "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData"
            ],
            "id": "2",
            "meta": {
                "resourceType": "PrivilegedData",
                "created": "2021-03-21T14:37:39Z",
                "lastModified": "2021-03-21T14:37:39Z",
                "location": "https://mytenant.idaptive.app/scim/v2/PrivilegedData/2"
            },
            "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
                "safe": "myContainer",
                "properties": [
                    {
                        "key": "username",
                        "value": "user2"
                    },
                    {
                        "key": "address",
                        "value": "192.0.1.1"
                    },
                    {
                        "key": "platformId",
                        "value": "WinServerLocal"
                    }
                ]
            }
        }

Sort results when you GET all PrivilegedData.

GET https://myTenant.idaptive.app/scim/PrivilegedData?sortby=name&sortorder=descending
GET https://myTenant.idaptive.app/scim/PrivilegedData?sortby=id&sortorder=descending
GET https://myTenant.idaptive.app/scim/PrivilegedData?sortby=meta.created&sortorder=descending
GET https://myTenant.idaptive.app/scim/PrivilegedData?sortby=meta.created&sortorder=ascending

GET a single PrivilegedData resource

Use the PrivilegedData ID to limit the response to a single PrivilegedData.
GET https://myTenant.idaptive.app/scim/PrivilegedData/1

{
    "name": "myPrivilegeData",
    "type": "password",
    "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData",
        "urn:ietf:params:scim:schemas:cyberaaark:1.0:PrivilegedData"
    ],
    "id": "1",
    "meta": {
        "resourceType": "PrivilegedData",
        "created": "2021-01-17T12:10:36Z",
        "lastModified": "2021-01-17T12:37:48Z",
        "location": "https://mytenant.idaptive.app/scim/PrivilegedData/1"
    },
    "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
        "safe": "myContainer",
        "properties": [
            {
                "key": "username",
                "value": "user1"
            },
            {
                "key": "address",
                "value": "192.0.2.1"
            },
            {
                "key": "platformId",
                "value": "WinDesktopLocal"
            }
        ]
    }
}

POST

Use POST to create a PrivilegedData object.
POST https://myTenant.idaptive.app/scim/PrivilegedData

{
    "name": "myPrivilegeData",
    "type": "password",
    "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData",
        "urn:ietf:params:scim:schemas:cyberaaark:1.0:PrivilegedData"
    ],
    "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
        "safe": "myContainer",
        "properties": [
            {
                "key": "username",
                "value": "user1"
            },
            {
                "key": "address",
                "value": "192.0.2.1"
            },
            {
                "key": "platformId",
                "value": "WinDesktopLocal"
            },
            {
                "key": "secret",
                "value": "123456"
            }
        ]
    }
}
{
    "name": "test123",
    "type": "password",
    "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData",
        "urn:ietf:params:scim:schemas:cyberaaark:1.0:PrivilegedData"
    ],
    "id": "2_26",
    "meta": {
        "resourceType": "PrivilegedData",
        "created": "2021-01-17T12:10:36Z",
        "lastModified": "2021-01-17T12:37:48Z",
        "location": "https://mytenant.idaptive.app/scim/PrivilegedData/2_26"
    },
    "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
        "safe": "safe 123",
        "properties": [
            {
                "key": "username",
                "value": "test123"
            },
            {
                "key": "address",
                "value": "192.0.2.1"
            },
            {
                "key": "platformId",
                "value": "WinDesktopLocal"
            }
        ]
    }
}

PATCH

Use PATCH to modify a PrivilegedData resource.
The following example adds a platformID attribute. The expected response is 20 PATCH https://myTenant.idaptive.app/scim/PrivilegedData/1`

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "add",
            "path": "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData.properties",
            "value": [
                {
                "key": "username",
                "value": "new user 3"
            },
            {
                "key": "address",
                "value": "192.0.2.1" 
                },
            {
                "key": "platformId",
                "value": "WinDomain"
            }
            ]
        }

    ]
}
{
    "name": "myPrivilegeData",
    "type": "password",
    "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData",
        "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData"
    ],
    "id": "1",
    "meta": {
        "resourceType": "PrivilegedData",
        "created": "2021-01-17T12:10:36Z",
        "lastModified": "2021-01-17T12:37:48Z",
        "location": "https://mytenant.idaptive.app/scim/PrivilegedData/1"
    },
    "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
        "safe": "myContainer",
        "properties": [
            {
                "key": "username",
                "value": "myUser1"
            },
            {
                "key": "address",
                "value": "192.0.2.1"
            },
            {
                "key": "platformId",
                "value": "WinDomain"
            }
        ]
    }
}

The following example shows a replace operation on username and address attributes.
PATCH https://myTenant.idaptive.app/scim/PrivilegedData/1

{
    "name": "myPrivilegeData",
    "type": "password",
    "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData",
        "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData"
    ],
    "id": "1",
    "meta": {
        "resourceType": "PrivilegedData",
        "created": "2021-02-16T14:01:22Z",
        "lastModified": "2021-02-18T08:30:41Z",
        "location": "https://mytenant.idaptive.app/Scim/PrivilegedData/1"
    },
    "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
        "safe": "myContainer",
        "properties": [
            {
                "key": "username",
                "value": "myUser1"
            },
            {
                "key": "address",
                "value": "192.0.2.1"
            },
            {
                "key": "platformId",
                "value": "WinDomain"
            }
        ]
    }
}
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "replace",
            "path": "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData.properties",
            "value": [
                {
                    "key": "address",
                    "value": "192.0.2.1"
                },
                {
                    "key": "username",
                    "value": "myUsername"
                }
            ]
        },
        {
            "op": "replace",
            "path": "name",
            "value": "myPrivilegeData1"
        }
    ]
}
{
    "name": "myPrivilegeData1",
    "type": "password",
    "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData",
        "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData"
    ],
    "id": "1",
    "meta": {
        "resourceType": "PrivilegedData",
        "created": "2021-02-16T14:01:22Z",
        "lastModified": "2021-02-18T08:37:39Z",
        "location": "https://mytenant.idaptive.app/scim/PrivilegedData/1"
    },
    "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
        "safe": "myContainer",
        "properties": [
            {
                "key": "username",
                "value": "myUsername"
            },
            {
                "key": "address",
                "value": "192.0.2.1"
            },
            {
                "key": "platformId",
                "value": "WinDomain"
            }
        ]
    }
}

PUT

Use PUT to modify a PrivilegedData resource.
PUT https://myTenant.idaptive.app/scim/PrivilegedData/1

{
    "name": "myPrivilegeData",
    "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData"
    ],
    "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
        "safe": "myContainer",
        "properties": [
            {
                "key": "username",
                "value": "myUsername"
            },
            {
                "key": "address",
                "value": "192.0.2.1"
            },
            {
                "key": "platformId",
                "value": "WinDesktopLocal"
            }
        ]
    }
}
{
    "name": "myPrivilegeData",
    "type": "password",
    "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:PrivilegedData",
        "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData"
    ],
    "id": "1",
    "meta": {
        "resourceType": "PrivilegedData",
        "created": "2021-01-17T12:10:36Z",
        "lastModified": "2021-01-17T12:37:48Z",
        "location": "https://mytenant.idaptive.app/scim/PrivilegedData/1"
    },
    "urn:ietf:params:scim:schemas:cyberark:1.0:PrivilegedData": {
        "safe": "myContainer",
        "properties": [
            {
                "key": "username",
                "value": "myUsername"
            },
            {
                "key": "address",
                "value": "192.0.2.1"
            },
            {
                "key": "platformId",
                "value": "WinDesktopLocal"
            }
        ]
    }
}

DELETE

Use DELETE to delete a PrivilegedData resource. You can only delete a single PrivilegedData resource at a time using the id.
DELETE https://myTenant.idaptive.app/scim/PrivilegedData/1

The response is 204.