HomeProduct documentationGitHubCyberArk developer community

Manage Containers with SCIM endpoints

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

Suggest Edits

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

  • GET
  • POST
  • DELETE
  • PUT

Examples

Refer to the following examples for common requests to Containers.

GET

GET a specific Container using the Container name. [Available only with 12.2 version of PVWA].
GET https://mytenant.idaptive.app/scim/Containers/myContainer

{
   "name":"myContainer",
   "displayName":"myContainer",
   "description":"This is safe testing",
   "type":"safe",
   "owner":{
      
   },
   "schemas":[
      "urn:ietf:params:scim:schemas:pam:1.0:Container",
      "urn:scim:schemas:extension:custom:2.0"
   ],
   "id":"myContainer",
   "meta":{
      "resourceType":"Container",
      "location":"https://mytenant.idaptive.app/Scim/Containers/myContainer"
   },
   "urn:scim:schemas:extension:custom:2.0":{
      "NumberOfDaysRetention":7
   }
}

GET all Containers.
GET https://mytenant.idaptive.app/scim/Containers

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 2,
    "itemsPerPage": 2,
    "startIndex": 1,
    "Resources": [
        {
            "name": "myContainer1",
            "displayName": "myContainer1",
            "description": "This is sample safe testing",
            "type": "safe",
            "owner": {
                "value": "1",
                "$ref": "https://mytenant.idaptive.app/Scim/v2/Users/1",
                "display": "identity-privilege-integration-user$"
            },
            "privilegedData": [
                {
                    "value": "52_88",
                    "$ref": "https://mytenant.idaptive.app/Scim/v2/PrivilegedData/52_88",
                    "display": "myPrivilegeData1"
                },
                {
                    "value": "52_17",
                    "$ref": "https://mytenant.idaptive.app/Scim/v2/PrivilegedData/52_17",
                    "display": "myPrivilegeData2"
                }
            ],
            "schemas": [
                "urn:ietf:params:scim:schemas:pam:1.0:Container",
                "urn:ietf:params:scim:schemas:cyberark:1.0:Safe"
            ],
            "id": "myContainer1",
            "meta": {
                "resourceType": "Container",
                "created": "2021-06-01T09:03:35.5Z",
                "lastModified": "2021-06-21T01:00:55.567Z",
                "location": "https://mytenant.idaptive.app/Scim/v2/Containers/myContainer1"
            },
            "urn:ietf:params:scim:schemas:cyberark:1.0:Safe": {
                "NumberOfDaysRetention": 8
            }
        },
        {
            "name": "myContainer2",
            "displayName": "myContainer2",
            "description": "This is sample safe testing",
            "type": "safe",
            "owner": {
                "value": "1",
                "$ref": "https://mytenant.idaptive.app/Scim/v2/Users/1",
                "display": "identity-privilege-integration-user$"
            },
            "privilegedData": [
                {
                    "value": "52_88",
                    "$ref": "https://mytenant.idaptive.app/Scim/v2/PrivilegedData/52_88",
                    "display": "myPrivilegeData3"
                },
                {
                    "value": "52_17",
                    "$ref": "https://mytenant.idaptive.app/Scim/v2/PrivilegedData/52_17",
                    "display": "myPrivilegeData4"
                }
            ],
            "schemas": [
                "urn:ietf:params:scim:schemas:pam:1.0:Container",
                "urn:ietf:params:scim:schemas:cyberark:1.0:Safe"
            ],
            "id": "myContainer2",
            "meta": {
                "resourceType": "Container",
                "created": "2021-06-01T09:17:55.5Z",
                "lastModified": "2021-06-21T01:00:55.57Z",
                "location": "https://mytenant.idaptive.app/Scim/v2/Containers/myContainer2"
            },
            "urn:ietf:params:scim:schemas:cyberark:1.0:Safe": {
                "NumberOfDaysRetention": 8
            }
        }
    ]
}

Sort results when you GET all Containers.
GET https://mytenant.idaptive.app/scim/Containers?sortby=name&sortorder=descending
GET https://mytenant.idaptive.app/scim/Containers?sortby=meta.created&sortorder=descending
GET https://mytenant.idaptive.app/scim/Containers?sortby=meta.created&sortorder=ascending

POST

POST https://mytenant.idaptive.app/scim/Containers

{
   "name":"myContainer",
   "description":"This is safe testing",
   "displayName":"myContainer",
   "schemas":[
      "urn:ietf:params:scim:schemas:pam:1.0:Container"
   ]
}

{
   "name":"myContainer",
   "displayName":"myContainer",
   "description":"This is safe testing",
   "type":"safe",
   "owner":{
      "value":"1",
      "display":"identity-privilege-integration-user$"
   },
   "schemas":[
      "urn:ietf:params:scim:schemas:pam:1.0:Container",
      "urn:ietf:params:scim:schemas:cyberark:1.0:Safe"
   ],
   "id":"myContainer",
   "meta":{
      "resourceType":"Container",
      "created":"2020-12-03T03:49:55.1521236Z",
      "lastModified":"2020-12-03T03:49:55.1521236Z",
      "location":"//mytenant.idaptive.app/Scim/Containers/myContainer"
   },
   "urn:ietf:params:scim:schemas:cyberark:1.0:Safe":{
      "NumberOfDaysRetention":7
   }
}

DELETE

DELETE https://mytenant.idaptive.app/scim/Containers/myContainer returns 1.

PUT

PUT https://mytenant.idaptive.app/scim/Containers
[Available only with 12.2 version of PVWA].
Change the name of the container
https://mytenant.idaptive.app/scim/Containers/myContainer1

{
    "name": "myContainer",
    "displayName": "myContainer",
    "type": "safe",
    "owner": {
        "value": "1",
        "$ref": "https://mytenant.idaptive.app/Scim/v2/Users/1",
        "display": "identity-privilege-integration-user$"
    },
        "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:Container",
        "urn:ietf:params:scim:schemas:cyberark:1.0:Safe"
    ],
    "id": "myContainer",
    "meta": {
        "resourceType": "Container",
        "created": "2021-06-18T04:45:08.8Z",
        "lastModified": "2021-06-18T04:45:09.911Z",
        "location": "https://mytenant.idaptive.app/Scim/v2/Containers/myContainer"
    },
    "urn:ietf:params:scim:schemas:cyberark:1.0:Safe": {
        "NumberOfDaysRetention": 56
    }
}

{
    "name": "myContainer",
    "displayName": "myContainer",
    "type": "safe",
    "owner": {
        "value": "1",
        "$ref": "https://mytenant.idaptive.app/Scim/v2/Users/1",
        "display": "identity-privilege-integration-user$"
    },
    "schemas": [
        "urn:ietf:params:scim:schemas:pam:1.0:Container",
        "urn:ietf:params:scim:schemas:cyberark:1.0:Safe"
    ],
    "id": "myContainer",
    "meta": {
        "resourceType": "Container",
        "created": "2021-06-18T04:45:08.8Z",
        "lastModified": "2021-06-21T07:53:27.755Z",
        "location": "https://mytenant.idaptive.app/Scim/v2/Containers/myContainer"
    },
    "urn:ietf:params:scim:schemas:cyberark:1.0:Safe": {
        "NumberOfDaysRetention": 56
    }
}

Updated almost 2 years ago