Entities Resource

Provides access to entity instances.

GET /{tenantGuid}/api/v1/entities/{entityDefId}

Available Since:
12.12.0

Search for entity instances by entityDefinitionId. For detailed information, see Getting started: Entities.

Sample request

Get Auth Delegates 

 GET / SRP00000 / api / v1 / entities / com.blackberry.mdm.common.entity.AuthDelegate

Sample response body

 
 {
     "entityInstances": [
         {
             "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
             "entityInstanceId": "005dcb36-9388-4d58-8987-5cfecc30983a",
             "settings": {
                 "authDelegateName": "BlackBerry Connect",
                 "authDelegateSid": "com.good.goodconnect"
             }
         },
         {
             "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
             "entityInstanceId": "8842fa09-0d52-4f48-b6f3-681b50752174",
             "settings": {
                 "authDelegateName": "AppPolicyTest",
                 "authDelegateSid": "com.nasaqa.apppolicy7"
             }
         },
         ...
         {
             "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
             "entityInstanceId": "b425b121-8dd8-4840-830d-dc179f467b33",
             "settings": {
                 "authDelegateName": "BlackBerry Notes",
                 "authDelegateSid": "com.blackberry.gd.notes"
             }
         }
     ]
 }

Request Parameters
Name Location Description
entityDefId path
filter query Query parameter for filtering the results. The format is <field name>filter operator<filter value>, for example osFamily==%22ANDROID%22. Filtering for empty/null values is not supported.
Response Codes
Code Condition Data type
200 OK (even if no entity instances are found).
404 Entity definition not found.
400 Invalid request. For example, invalid field semantics or missing required field.
Response Body
Media type Data type Description
application/vnd.blackberry.entityinstances-v1+json Entity instances (JSON)

POST /{tenantGuid}/api/v1/entities/{entityDefId}

Available Since:
12.12.0

Create an entity instance. If values are specified for conditional properties where the condition is met and the outcome is irrelevant, then these properties are ignored. For detailed information, see Getting started: Entities.

Sample request

 
 {
     "entityDefId": "com.blackberry.mdm.common.entity.profile.DynamicsSecurityProfile",
     "settings": {
         "allPwdAndroidFingerprintAndroidFingerprintColdStart": true,
         "allPwdFormatMaxRepeatX": 3,
         "allWearableAllowAutoReconnect": true,
         "allPwdBiometricsXTOUCHRequirePasswordNotTouchIDPeriod": 1,
         "allPwdFormatIsAlphaNum": true,
         "allWearableAllow": true,
         "allPwdDisallowNumericSequence": true,
         "allDataLeakagePreventionPreventScreenCapture": true,
         "allDataLeakagePreventionPreventiOSScreenRecordingSharing": true,
         "allAllowedCertsUsePkcs12CertEnabled": true,
         "allPwdExpirationX": 60,
         "allPwdAndroidFingerprint": true,
         "allPwdBiometricsXTOUCHFACEColdStart": false,
         "allDetailedLoggingEnableDetailedLogging": false,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDApp": true,
         "allPwdMinLenX": 4,
         "allDeviceLockLockOnBg": false,
         "allPwdDisallowPersonalInfo": true,
         "allDataLeakagePreventionPreventKeyboardExtension": true,
         "name": "Test name",
         "allEnableOnBesClientMdmApp": true,
         "allDeviceLockTakeActionXDeviceLockScreenType": "LOCK_USER",
         "allEnableOnBesClientActivate": true,
         "allPwdBiometricsXFACERequirePasswordNotFaceIDPeriod": 1,
         "allDataLeakagePreventionPreventiOSDictation": true,
         "enableIncognitoMode": false,
         "allPwdBiometricsXTOUCHFACERequirePasswordNotTouchFaceIDPeriod": 1,
         "allPwdBiometricsXTOUCHColdStart": false,
         "allPwdFormatIsMixedCase": false,
         "description": "testDescription2\n",
         "allDisclaimerPolicyEnable": true,
         "allDeviceLockPwdTimeout": 60,
         "authDelegate": [
             {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "5e3a79ab-80f5-4529-9b2a-853df8b739d3",
                 "settings": {
                     "authDelegateName": "BlackBerry Access",
                     "authDelegateSid": "com.good.gdgma"
                 }
             },
             {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "cf961c92-38a8-48ad-a23f-6df9735f0153",
                 "settings": {
                     "authDelegateName": "BlackBerry Connect",
                     "authDelegateSid": "com.good.goodconnect"
                 }
             }
         ],
         "allDataLeakagePreventionPreventAndroidDictation": true,
         "allDataLeakagePreventionEnableFIPS": false,
         "modifiedBy": "admin.user1_displayName",
         "allPwdBiometricsXFACEColdStart": false,
         "allDisclaimerPolicyEnableFrequency": true,
         "allDeviceLockTakeActionX": true,
         "allPwdFormatSpecialChar": false,
         "allPwdDonotRequireUserPwd": [
             2,
             8,
             4
         ],
         "allPwdRestrictChange": false,
         "allDeviceLockTakeActionXAllowedPwdAttempts": 10,
         "allAllowedCertsEnabled": true,
         "allPwdAndroidFingerprintRequirePasswordNotFingerprintPeriod": 1,
         "allBannedPasswordsFile": {
             "fileName": "testPsw.txt",
             "fileType": "txt",
             "timestamp": "2019-08-27T13:58:38.546Z",
             "content": "cGFzc3dvcmQxCnBhc3N3b3JkMg=="
         },
         "allPwdHistoryX": 8,
         "allDisclaimerPolicyEnableMessage": "test Message line21\ntest Message line22\ntest Message end2",
         "allPwdBiometricsX": "TOUCHFACE",
         "allAuthDelegationPolicyAllowSelfAuthentication": false,
         "allDetailedLoggingPreventDetailedLogging": true,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDAppPreventCopyPasteFromNonGDToGDApp": false,
         "allWearableAllowTimeoutX": 30
     }
 }

Sample response body

 
 {
     "entityDefId": "com.blackberry.mdm.common.entity.profile.DynamicsSecurityProfile",
     "entityInstanceId": "1023153f-58d3-44c4-97c3-6bacc8f0aa79",
     "settings": {
         "adminValidationRequired": false,
         "modifiedBySystem": false,
         "allPwdAndroidFingerprintAndroidFingerprintColdStart": true,
         "allPwdFormatMaxRepeatX": 3,
         "allWearableAllowAutoReconnect": true,
         "allPwdBiometricsXTOUCHRequirePasswordNotTouchIDPeriod": 1,
         "allPwdFormatIsAlphaNum": true,
         "allWearableAllow": true,
         "allPwdDisallowNumericSequence": true,
         "allDataLeakagePreventionPreventScreenCapture": true,
         "allDataLeakagePreventionPreventiOSScreenRecordingSharing": true,
         "rank": 7,
         "createdTime": "2019-09-17T18:43:11.429Z",
         "allAllowedCertsUsePkcs12CertEnabled": true,
         "allPwdExpirationX": 60,
         "allPwdAndroidFingerprint": true,
         "allPwdBiometricsXTOUCHFACEColdStart": false,
         "allDetailedLoggingEnableDetailedLogging": false,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDApp": true,
         "allPwdMinLenX": 4,
         "allDeviceLockLockOnBg": false,
         "isDefault": false,
         "allPwdDisallowPersonalInfo": true,
         "allDataLeakagePreventionPreventKeyboardExtension": true,
         "name": "Test name",
         "allEnableOnBesClientMdmApp": true,
         "allDeviceLockTakeActionXDeviceLockScreenType": "LOCK_USER",
         "allEnableOnBesClientActivate": true,
         "allPwdBiometricsXFACERequirePasswordNotFaceIDPeriod": 1,
         "allDataLeakagePreventionPreventiOSDictation": true,
         "enableIncognitoMode": false,
         "allPwdBiometricsXTOUCHFACERequirePasswordNotTouchFaceIDPeriod": 1,
         "lastModifiedTime": "2019-09-17T18:43:11.429Z",
         "allPwdBiometricsXTOUCHColdStart": false,
         "allPwdFormatIsMixedCase": false,
         "description": "testDescription2\n",
         "allDisclaimerPolicyEnable": true,
         "allDeviceLockPwdTimeout": 60,
         "authDelegate": [
             {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "5e3a79ab-80f5-4529-9b2a-853df8b739d3",
                 "settings": {
                     "authDelegateName": "BlackBerry Access",
                     "authDelegateSid": "com.good.gdgma"
                 }
             },
             {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "cf961c92-38a8-48ad-a23f-6df9735f0153",
                 "settings": {
                     "authDelegateName": "BlackBerry Connect",
                     "authDelegateSid": "com.good.goodconnect"
                 }
             }
         ],
         "allDataLeakagePreventionPreventAndroidDictation": true,
         "allDataLeakagePreventionEnableFIPS": false,
         "modifiedBy": "admin.user1_displayName",
         "allPwdBiometricsXFACEColdStart": false,
         "allDisclaimerPolicyEnableFrequency": true,
         "allDeviceLockTakeActionX": true,
         "allPwdFormatSpecialChar": false,
         "allPwdDonotRequireUserPwd": [
             2,
             8,
             4
         ],
         "allPwdRestrictChange": false,
         "allDeviceLockTakeActionXAllowedPwdAttempts": 10,
         "allAllowedCertsEnabled": true,
         "allPwdAndroidFingerprintRequirePasswordNotFingerprintPeriod": 1,
         "allBannedPasswordsFile": {
             "fileName": "testPsw.txt",
             "fileType": "txt",
             "timestamp": "2019-08-27T13:58:38.546Z",
             "content": "cGFzc3dvcmQxCnBhc3N3b3JkMg=="
         },
         "allPwdHistoryX": 8,
         "allDisclaimerPolicyEnableMessage": "test Message line21\ntest Message line22\ntest Message end2",
         "allPwdBiometricsX": "TOUCHFACE",
         "allAuthDelegationPolicyAllowSelfAuthentication": false,
         "allDetailedLoggingPreventDetailedLogging": true,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDAppPreventCopyPasteFromNonGDToGDApp": false,
         "allWearableAllowTimeoutX": 30
     }
 }

Request Parameters
Name Location Description
entityDefId path
Request Body
Media type Data type
application/vnd.blackberry.entityinstance-v1+json Entity instance (JSON)
Response Codes
Code Condition Data type
201 Entity instance created.
400 Invalid request. For example, invalid field semantics or missing required field.
404 Entity definition not found.
409 Entity instance already exists for this entity definition.
Response Body
Media type Data type Description
application/vnd.blackberry.entityinstance-v1+json Entity instance (JSON)
Response Headers
Name Description
Location Location of the created entity instance. Can be used to perform a GET request to retrieve the created entity instance. Only present when status is 201.

GET /{tenantGuid}/api/v1/entities/{entityDefId}/template

Available Since:
12.12.0

Get an entity instance template by entity definition ID. The template is an entity instance with all properties set to their initial value. This template can be used to create new entity instances. For detailed information, see Getting started: Entities.

Sample request

 GET /SRP00000/api/v1/entities/com.blackberry.mdm.common.entity.profile.DynamicsSecurityProfile/template

Sample response body

 
 {
     "entityDefId": "com.blackberry.mdm.common.entity.profile.DynamicsSecurityProfile",
     "settings": {
         "allPwdBiometricsXTOUCHFACERequirePasswordNotTouchFaceIDPeriod": 1,
         "allPwdBiometricsXTOUCHColdStart": false,
         "allPwdFormatMaxRepeatX": 3,
         "allPwdAndroidFingerprintAndroidFingerprintColdStart": false,
         "allPwdFormatIsMixedCase": false,
         "allDisclaimerPolicyEnable": false,
         "allPwdFormatIsAlphaNum": false,
         "allPwdBiometricsXTOUCHRequirePasswordNotTouchIDPeriod": 1,
         "allWearableAllowAutoReconnect": false,
         "allWearableAllow": false,
         "allDeviceLockPwdTimeout": 60,
         "authDelegate": [

         ],
         "allPwdDisallowNumericSequence": false,
         "allDataLeakagePreventionPreventScreenCapture": true,
         "allDataLeakagePreventionPreventiOSScreenRecordingSharing": true,
         "allDataLeakagePreventionPreventAndroidDictation": true,
         "allDataLeakagePreventionEnableFIPS": false,
         "allPwdBiometricsXFACEColdStart": false,
         "allDisclaimerPolicyEnableFrequency": false,
         "allAllowedCertsUsePkcs12CertEnabled": true,
         "allPwdExpirationX": 0,
         "allPwdBiometricsXTOUCHFACEColdStart": false,
         "allPwdAndroidFingerprint": true,
         "allDeviceLockTakeActionX": true,
         "allPwdFormatSpecialChar": false,
         "allPwdDonotRequireUserPwd": [

         ],
         "allPwdRestrictChange": false,
         "allDeviceLockTakeActionXAllowedPwdAttempts": 10,
         "allAllowedCertsEnabled": true,
         "allDetailedLoggingEnableDetailedLogging": false,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDApp": true,
         "allPwdAndroidFingerprintRequirePasswordNotFingerprintPeriod": 1,
         "allPwdHistoryX": 0,
         "allPwdMinLenX": 4,
         "allDeviceLockLockOnBg": false,
         "allPwdDisallowPersonalInfo": true,
         "allDataLeakagePreventionPreventKeyboardExtension": true,
         "allPwdBiometricsX": "TOUCHFACE",
         "allAuthDelegationPolicyAllowSelfAuthentication": false,
         "allEnableOnBesClientMdmApp": false,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDAppPreventCopyPasteFromNonGDToGDApp": false,
         "allDetailedLoggingPreventDetailedLogging": true,
         "allDeviceLockTakeActionXDeviceLockScreenType": "LOCK_USER",
         "allWearableAllowTimeoutX": 0,
         "allEnableOnBesClientActivate": true,
         "allPwdBiometricsXFACERequirePasswordNotFaceIDPeriod": 1,
         "allDataLeakagePreventionPreventiOSDictation": true,
         "enableIncognitoMode": false
     }

Request Parameters
Name Location Description
entityDefId path
Response Codes
Code Condition Data type
200 OK.
400 Invalid request. For example, invalid field semantics or missing required field.
404 Entity definition not found.
404 Entity instance not found.
Response Body
Media type Data type Description
application/vnd.blackberry.entityinstance-v1+json Entity instance (JSON)

DELETE /{tenantGuid}/api/v1/entities/{entityDefId}/{entityInstanceId}

Available Since:
12.12.0

Delete an entity instance using the entity definition ID and entity instance ID. For detailed information, see Getting started: Entities.

Sample request

 DELETE /SRP00000/api/v1/entities/com.blackberry.mdm.common.entity.profile.DynamicsSecurityProfile/627c4a05-1bd7-4537-af16-bbc5191e0b0d

Request Parameters
Name Location Description
entityDefId path
entityInstanceId path
Response Codes
Code Condition Data type
204 Entity instance deleted.
    404 Entity definition not found.
    404 Entity instance not found.
    400 When attempting to delete a default entity instance.

    GET /{tenantGuid}/api/v1/entities/{entityDefId}/{entityInstanceId}

    Available Since:
    12.12.0

    Get an entity instance by the entity definition ID and the entity instance ID. For detailed information, see Getting started: Entities.

    Sample request

     GET /SRP00000/api/v1/entities/com.blackberry.mdm.common.entity.AuthDelegate/005dcb36-9388-4d58-8987-5cfecc30983a

    Sample response body

     
 {
     "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
     "entityInstanceId": "005dcb36-9388-4d58-8987-5cfecc30983a",
         "settings": {
             "authDelegateName": "BlackBerry Connect",
             "authDelegateSid": "com.good.goodconnect"
         }
 }

    Request Parameters
    Name Location Description
    entityDefId path
    entityInstanceId path
    dynamicsContainerId query Optional query parameter specifying the GUID of a Dynamics container. If this parameter is specified the returned response is filtered for the specified container. Currently this filtering consists of returning elements that have a "device-mapping" definition using the device-mapping name as the property key.
    Response Codes
    Code Condition Data type
    200 OK.
    400 Invalid request. For example, invalid field semantics or missing required field.
    404 Entity definition not found.
    Response Body
    Media type Data type Description
    application/vnd.blackberry.entityinstance-v1+json Entity instance (JSON)

    PUT /{tenantGuid}/api/v1/entities/{entityDefId}/{entityInstanceId}

    Available Since:
    12.12.0

    Update an existing entity instance. This API overwrites values for properties that are provided in the payload, and also resets default values for any properties that are not included in the payload. If values are specified for conditional properties where the condition is met and the outcome is irrelevant, then these properties are ignored. For detailed information, see Getting started: Entities.

    Sample request

     PUT /SRP00000/api/v1/entities/com.blackberry.mdm.common.entity.profile.DynamicsSecurityProfile/1023153f-58d3-44c4-97c3-6bacc8f0aa79
 
     
 {
     "entityDefId": "com.blackberry.mdm.common.entity.profile.DynamicsSecurityProfile",
     "entityInstanceId": "1023153f-58d3-44c4-97c3-6bacc8f0aa79",
     "settings": {
         "allPwdAndroidFingerprintAndroidFingerprintColdStart": true,
         "allPwdFormatMaxRepeatX": 3,
         "allWearableAllowAutoReconnect": true,
         "allPwdBiometricsXTOUCHRequirePasswordNotTouchIDPeriod": 1,
         "allPwdFormatIsAlphaNum": true,
         "allWearableAllow": true,
         "allPwdDisallowNumericSequence": true,
         "allDataLeakagePreventionPreventScreenCapture": true,
         "allDataLeakagePreventionPreventiOSScreenRecordingSharing": true,
         "allAllowedCertsUsePkcs12CertEnabled": true,
         "allPwdExpirationX": 60,
         "allPwdAndroidFingerprint": true,
         "allPwdBiometricsXTOUCHFACEColdStart": false,
         "allDetailedLoggingEnableDetailedLogging": false,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDApp": true,
         "allPwdMinLenX": 4,
         "allDeviceLockLockOnBg": false,
         "allPwdDisallowPersonalInfo": true,
         "allDataLeakagePreventionPreventKeyboardExtension": true,
         "name": "Test name2",
         "allEnableOnBesClientMdmApp": true,
         "allDeviceLockTakeActionXDeviceLockScreenType": "LOCK_USER",
         "allEnableOnBesClientActivate": true,
         "allPwdBiometricsXFACERequirePasswordNotFaceIDPeriod": 1,
         "allDataLeakagePreventionPreventiOSDictation": true,
         "enableIncognitoMode": false,
         "allPwdBiometricsXTOUCHFACERequirePasswordNotTouchFaceIDPeriod": 1,
         "allPwdBiometricsXTOUCHColdStart": false,
         "allPwdFormatIsMixedCase": false,
         "description": "testDescription2\n",
         "allDisclaimerPolicyEnable": true,
         "allDeviceLockPwdTimeout": 60,
         "authDelegate": [
             {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "5e3a79ab-80f5-4529-9b2a-853df8b739d3",
                 "settings": {
                     "authDelegateName": "BlackBerry Access",
                     "authDelegateSid": "com.good.gdgma"
                 }
             },
             {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "cf961c92-38a8-48ad-a23f-6df9735f0153",
                 "settings": {
                     "authDelegateName": "BlackBerry Connect",
                     "authDelegateSid": "com.good.goodconnect"
                 }
             }
         ],
         "allDataLeakagePreventionPreventAndroidDictation": true,
         "allDataLeakagePreventionEnableFIPS": false,
         "modifiedBy": "admin.user1_displayName",
         "allPwdBiometricsXFACEColdStart": false,
         "allDisclaimerPolicyEnableFrequency": true,
         "allDeviceLockTakeActionX": true,
         "allPwdFormatSpecialChar": false,
         "allPwdDonotRequireUserPwd": [
             2,
             8,
             4
         ],
         "allPwdRestrictChange": false,
         "allDeviceLockTakeActionXAllowedPwdAttempts": 10,
         "allAllowedCertsEnabled": true,
         "allPwdAndroidFingerprintRequirePasswordNotFingerprintPeriod": 1,
         "allBannedPasswordsFile": {
             "fileName": "testPsw.txt",
             "fileType": "txt",
             "timestamp": "2019-08-27T13:58:38.546Z",
             "content": "cGFzc3dvcmQxCnBhc3N3b3JkMg=="
         },
         "allPwdHistoryX": 8,
         "allDisclaimerPolicyEnableMessage": "test Message line21\ntest Message line22\ntest Message end2",
         "allPwdBiometricsX": "TOUCHFACE",
         "allAuthDelegationPolicyAllowSelfAuthentication": false,
         "allDetailedLoggingPreventDetailedLogging": true,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDAppPreventCopyPasteFromNonGDToGDApp": false,
         "allWearableAllowTimeoutX": 30
     }
 }

    Sample response body

     
 {
     "entityDefId": "com.blackberry.mdm.common.entity.profile.DynamicsSecurityProfile",
     "entityInstanceId": "1023153f-58d3-44c4-97c3-6bacc8f0aa79",
     "settings": {
         "adminValidationRequired": false,
         "modifiedBySystem": false,
         "allPwdAndroidFingerprintAndroidFingerprintColdStart": true,
         "allPwdFormatMaxRepeatX": 3,
         "allWearableAllowAutoReconnect": true,
         "allPwdBiometricsXTOUCHRequirePasswordNotTouchIDPeriod": 1,
         "allPwdFormatIsAlphaNum": true,
         "allWearableAllow": true,
         "allPwdDisallowNumericSequence": true,
         "allDataLeakagePreventionPreventScreenCapture": true,
         "allDataLeakagePreventionPreventiOSScreenRecordingSharing": true,
         "rank": 7,
         "createdTime": "2019-09-17T18:43:11.429Z",
         "allAllowedCertsUsePkcs12CertEnabled": true,
         "allPwdExpirationX": 60,
         "allPwdAndroidFingerprint": true,
         "allPwdBiometricsXTOUCHFACEColdStart": false,
         "allDetailedLoggingEnableDetailedLogging": false,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDApp": true,
         "allPwdMinLenX": 4,
         "allDeviceLockLockOnBg": false,
         "isDefault": false,
         "allPwdDisallowPersonalInfo": true,
         "allDataLeakagePreventionPreventKeyboardExtension": true,
         "name": "Test name2",
         "allEnableOnBesClientMdmApp": true,
         "allDeviceLockTakeActionXDeviceLockScreenType": "LOCK_USER",
         "allEnableOnBesClientActivate": true,
         "allPwdBiometricsXFACERequirePasswordNotFaceIDPeriod": 1,
         "allDataLeakagePreventionPreventiOSDictation": true,
         "enableIncognitoMode": false,
         "allPwdBiometricsXTOUCHFACERequirePasswordNotTouchFaceIDPeriod": 1,
         "lastModifiedTime": "2019-09-17T18:53:11.429Z",
         "allPwdBiometricsXTOUCHColdStart": false,
         "allPwdFormatIsMixedCase": false,
         "description": "testDescription2\n",
         "allDisclaimerPolicyEnable": true,
         "allDeviceLockPwdTimeout": 60,
         "authDelegate": [
             {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "5e3a79ab-80f5-4529-9b2a-853df8b739d3",
                 "settings": {
                     "authDelegateName": "BlackBerry Access",
                     "authDelegateSid": "com.good.gdgma"
                 }
             },
             {
                 "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
                 "entityInstanceId": "cf961c92-38a8-48ad-a23f-6df9735f0153",
                 "settings": {
                     "authDelegateName": "BlackBerry Connect",
                     "authDelegateSid": "com.good.goodconnect"
                 }
             }
         ],
         "allDataLeakagePreventionPreventAndroidDictation": true,
         "allDataLeakagePreventionEnableFIPS": false,
         "modifiedBy": "admin.user1_displayName",
         "allPwdBiometricsXFACEColdStart": false,
         "allDisclaimerPolicyEnableFrequency": true,
         "allDeviceLockTakeActionX": true,
         "allPwdFormatSpecialChar": false,
         "allPwdDonotRequireUserPwd": [
             2,
             8,
             4
         ],
         "allPwdRestrictChange": false,
         "allDeviceLockTakeActionXAllowedPwdAttempts": 10,
         "allAllowedCertsEnabled": true,
         "allPwdAndroidFingerprintRequirePasswordNotFingerprintPeriod": 1,
         "allBannedPasswordsFile": {
             "fileName": "testPsw.txt",
             "fileType": "txt",
             "timestamp": "2019-08-27T13:58:38.546Z",
             "content": "cGFzc3dvcmQxCnBhc3N3b3JkMg=="
         },
         "allPwdHistoryX": 8,
         "allDisclaimerPolicyEnableMessage": "test Message line21\ntest Message line22\ntest Message end2",
         "allPwdBiometricsX": "TOUCHFACE",
         "allAuthDelegationPolicyAllowSelfAuthentication": false,
         "allDetailedLoggingPreventDetailedLogging": true,
         "allDataLeakagePreventionPreventCopyPasteFromGDToNonGDAppPreventCopyPasteFromNonGDToGDApp": false,
         "allWearableAllowTimeoutX": 30
     }
 }

    Request Parameters
    Name Location Description
    entityDefId path
    entityInstanceId path
    Request Body
    Media type Data type
    application/vnd.blackberry.entityinstance-v1+json Entity instance (JSON)
    Response Codes
    Code Condition Data type
    200 Entity instance updated.
    400 Invalid request. For example, invalid field semantics or missing required field.
    404 Entity definition not found.
    404 Entity instance not found.
    409 Entity instance already exists for this entity definition.
    Response Body
    Media type Data type Description
    application/vnd.blackberry.entityinstance-v1+json Entity instance (JSON)

    GET /{tenantGuid}/api/v1/entityDefs

    Available Since:
    12.12.0

    Get all entity definitions.

    Sample response body

     
 {
     "entityDefs": [
         {
             "name": "Authentication delegate",
             "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate"
         },
         {
             "name": "BlackBerry Dynamics",
             "entityDefId": "com.blackberry.mdm.common.entity.profile.DynamicsSecurityProfile"
         }
     ]
 }

    Response Codes
    Code Condition Data type
    200 OK (even if no entity definitions are found).
    400 Invalid request. For example, invalid field semantics or missing required field.
    Response Body
    Media type Data type Description
    application/vnd.blackberry.entitydefinitions-v1+json Entity definitions (JSON)

    GET /{tenantGuid}/api/v1/entityDefs/{entityDefId}

    Available Since:
    12.12.0

    Get one entity definition by ID.

    Sample response body

     
 {
     "entityDefId": "com.blackberry.mdm.common.entity.AuthDelegate",
     "settings": [
         {
             "name": "createdBy",
             "type": "text",
             "required": false,
             "minLength": 0,
             "maxLength": -1
         },
         {
             "name": "modifiedBy",
             "type": "text",
             "required": false,
             "minLength": 0,
             "maxLength": -1
         },
         {
             "name": "modifiedBySystem",
             "type": "boolean",
             "required": false
         },
         {
             "name": "authDelegateSid",
             "type": "text",
             "required": true,
             "minLength": 0,
             "maxLength": -1
         },
         {
             "name": "authDelegateName",
             "type": "text",
             "required": true,
             "minLength": 0,
             "maxLength": -1
         }
     ]
 }

    Request Parameters
    Name Location Description
    entityDefId path ID of the entity definition to get
    Response Codes
    Code Condition Data type
    200 OK.
    400 Invalid request. For example, invalid field semantics or missing required field.
    404 Entity definition not found.
    Response Body
    Media type Data type Description
    application/vnd.blackberry.entitydefinition-v1+json Entity definition (JSON)