Deprecated APIs
The following table shows the IBM® Verify APIs that are deprecated.
For the most current API information, see IBM Verify Documentation Hub.
For more information, see the API documentation in the IBM Verify Documentation Hub.
Watch a Verify API
video in the IBM Security Learning Academy.
APIs subject to deprecation
The following APIs are being deprecated and will be removed after their end of life date. Use the
replacement APIs.
| API | Deprecated | Replacement | End of life |
|---|---|---|---|
| Password policy APIs | |||
| Get the password policy for a specified tenant. | GET /v2.0/PasswordPolicies |
GET /v3.0/PasswordPolicies/{id} |
31 July 2027 |
| Update the password policy for a specified tenant. | PUT /v2.0/PasswordPolicies |
PATCH /v3.0/PasswordPolicies/{id} |
31 July 2027 |
| This API is used to get the password policy labels for a specified tenant using the specified locale. | GET /v2.0/PasswordPolicies/labels |
GET /v3.0/PasswordPolicies/{id}/labels |
31 July 2027 |
| Fetches the password dictionary policy in Cloud Directory. | GET /v3.0/DictionaryPolicy |
GET /v3.0/DictionaryPolicy/multi/{id} |
31 July 2027 |
| Modifies the password dictionary policy in Cloud Directory. | GET /v3.0/DictionaryPolicy |
PATCH /v3.0/DictionaryPolicy/multi/{id} |
31 July 2027 |
| Certification campaign assignment APIs | |||
| Retrieve all assignments in a given campaign instance | GET /v1.0/admin/instances/{id}/assignments |
GET /v2.0/instances/{id}/assignments |
31 December 2025 |
POST /v1.0/admin/instances/{id}/assignments |
POST /v2.0/instances/{id}/assignments |
31 December 2025 | |
| Retrieve a specific assignment | GET /v1.0/admin/assignments/{id} |
GET /v2.0/assignments/{id} |
31 December 2025 |
GET /v1.0/self/assignments/{id} |
GET /v2.0/assignments/{id} |
31 December 2025 | |
| Modify a given assignment | PUT /v1.0/admin/assignments/{id} |
PUT /v2.0/assignments/{id} |
31 December 2025 |
PUT /v1.0/self/assignments/{id} |
PUT /v2.0/assignments/{id} |
31 December 2025 | |
| Add new assignments to a continuous campaign instance | POST /v1.0/admin/instance/{id}/assignments |
POST /v2.0/instances/{id}/assignments |
31 December 2025 |
| Modify a given set of assignments | PATCH /v1.0/admin/instance/{id}/assignments |
PATCH /v2.0/instance/{id}/assignments |
31 December 2025 |
PATCH /v1.0/self/instance/{id}/assignments |
PATCH /v2.0/instance/{id}/assignments |
31 December 2025 | |
| Retrieve all assignments in a given campaign instance | GET /v1.0/self/instances/{id}/assignments |
GET /v2.0/instances/{id}/assignments |
31 December 2025 |
POST /v1.0/self/instances/{id}/assignments |
POST /v2.0/instances/{id}/assignments |
31 December 2025 | |
| Refresh assignments in a continuous campaign | POST /v1.0/admin/instance/{id}/assignments/refresh |
31 December 2025 | |
| Add new assignments to a continuous campaign | POST /v1.0/admin/campaign/{id}/assignments |
POST /v2.0/campaign/{id}/assignments |
31 December 2025 |
| Certification campaign configuration APIs | |||
| Retrieve a specific campaign configuration | GET /v1.0/admin/campaigns/{id} |
GET /v2.0/campaigns/{id} |
31 December 2025 |
| Edit specific campaign configuration | PUT /v1.0/admin/campaigns/{id} |
PUT /v2.0/campaigns/{id} |
31 December 2025 |
| delete specific campaign configuration | DELETE /v1.0/admin/campaigns/{id} |
DELETE /v2.0/campaigns/{id} |
31 December 2025 |
| Retrieve the campaign configuration | GET /v1.0/admin/campaigns |
GET /v2.0/campaigns |
31 December 2025 |
| Create a campaign configuration | POST /v1.0/admin/campaigns |
POST /v2.0/campaigns |
31 December 2025 |
| Edit campaign configuration | PATCH /v1.0/admin/campaigns |
PATCH /v2.0/campaigns |
31 December 2025 |
| Certification campaign instance APIs | |||
| Retrieve campaign instances | GET /v1.0/admin/instances |
GET /v2.0/instances |
31 December 2025 |
| Modify campaign instances | PATCH /v1.0/admin/instances |
PATCH /v2.0/instances |
31 December 2025 |
| Retrieve instances corresponding to a specific campaign configuration | GET /v1.0/admin/campaigns/{id}/instances |
GET /v2.0/campaigns/{id}/instances |
31 December 2025 |
GET /v1.0/self/campaigns/{id}/instances |
GET /v2.0/campaigns/{id}/instances |
31 December 2025 | |
| Retrieve specific campaign instances | GET /v1.0/admin/instances/{id} |
GET /v2.0/instances/{id} |
31 December 2025 |
GET /v1.0/self/instances/{id} |
GET /v2.0/instances/{id} |
31 December 2025 | |
| Modify specific campaign instance | PUT /v1.0/admin/instances/{id} |
PUT /v2.0/instances/{id} |
31 December 2025 |
| Retrieve campaign instances | GET /v1.0/self/instances |
GET /v2.0/instances |
31 December 2025 |
| Create a preview campaign | POST /v1.0/admin/instances/{id}/preview |
POST /v2.0/instances/{id}/preview |
31 December 2025 |
| Certification campaign statistic APIs | |||
| Retrieve statistics of specific assignments within a given campaign instance | GET /v1.0/self/instances/{instanceId}/assignments/resources |
GET /v2.0/instances/{instanceId}/assignments/resources |
31 December 2025 |
GET /v1.0/admin/instances/{instanceId}/assignments/resources |
GET /v2.0/instances/{instanceId}/assignments/resources |
31 December 2025 | |
| Retrieve statistics of specific assignments | GET /v1.0/admin/assignments/stats |
GET /v2.0/assignments/stats |
31 December 2025 |
GET /v1.0/self/assignments/stats |
GET /v2.0/assignments/stats |
31 December 2025 | |
| Retrieve statistics of specific campaign instances | GET /v1.0/self/instances/stats |
GET /v2.0/instances/stats |
31 December 2025 |
GET /v1.0/admin/instances/stats |
GET /v2.0/instances/stats |
31 December 2025 | |
| Retrieve campaign statistics | GET /v1.0/admin/campaigns/stats |
GET /v2.0/campaigns/stats |
31 December 2025 |
| Retrieve statistics of specific campaign instances. | GET /v1.0/admin/instances/stats |
GET /v2.0/instances/stats |
31 December 2025 |
| Retrieve statistics of specific assignments. | GET /v1.0/self/assignments/stats |
GET /v2.0/assignments/stats |
31 December 2025 |
| Administrator dynamic role APIs | |||
| Create administrator dynamic role | POST /v1.0/admin/entitlements |
POST /v1.0/dynamicgroups/ |
01 July 2026 |
| Get administrator dynamic role details | GET /v1.0/admin/entitlements/{entitlement} |
GET /v1.0/dynamicgroups/{id} |
01 July 2026 |
| Get all administrator dynamic roles | POST /v1.0/admin/entitlements/search |
GET /v1.0/dynamicgroups |
01 July 2026 |
| Update administrator dynamic role | PATCH /v1.0/admin/entitlements/{entitlement} |
PATCH /v1.0/dynamicgroups/{id} |
01 July 2026 |
| Delete administrator dynamic role | DELETE /v1.0/admin/entitlements/{entitlement} |
DELETE /v1.0/dynamicgroups/{id} |
01 July 2026 |
| Publish/discard administrator dynamic role | PATCH /v1.0/admin/entitlements/{entitlement}/{operation} |
PATCH /v1.0/dynamicgroups/{id}/{operation} |
01 July 2026 |
| Review administrator dynamic role membership | POST /v1.0/admin/entitlements/review/search |
GET /v1.0/dynamicgroups/{id}/reviewmembers |
01 July 2026 |
| Get administrator dynamic role active membership | POST /v1.0/admin/entitlements/assignments/search |
GET /v1.0/dynamicgroups/{id}/members |
01 July 2026 |
|
Note: The existing administrator dynamic role management APIs are restricted for explicit use. To
use deprecated API instead of replacement, pass one additional query parameter
isDR
as true. |
|||
| Application dynamic role APIs | |||
| Create application dynamic role | POST /v1.0/entitlements |
POST /v1.0/dynamicgroups/ |
01 July 2026 |
| Get application dynamic role details | GET /v1.0/entitlements/{entitlement} |
GET /v1.0/dynamicgroups/{id} |
01 July 2026 |
| Get all application dynamic roles | POST /v1.0/entitlements/search |
GET /v1.0/dynamicgroups |
01 July 2026 |
| Update application dynamic role | PATCH /v1.0/entitlements/{entitlement} |
PATCH /v1.0/dynamicgroups/{id} |
01 July 2026 |
| Delete application dynamic role | DELETE /v1.0/entitlements/{entitlement} |
DELETE /v1.0/dynamicgroups/{id} |
01 July 2026 |
| Publish/discard application dynamic role | PATCH /v1.0/entitlements/{entitlement}/{operation} |
PATCH /v1.0/dynamicgroups/{id}/{operation} |
01 July 2026 |
| Review application dynamic role membership | POST /v1.0/entitlements/review/search |
GET /v1.0/dynamicgroups/{id}/reviewmembers |
01 July 2026 |
| Get application dynamic role active membership | POST /v1.0/entitlements/assignments/search |
GET /v1.0/dynamicgroups/{id}/members |
01 July 2026 |
| Identity source APIs | |||
| Create identity source | /v1.0/identitysources |
/v2.0/identitysources |
01 June 2025 |
| Delete identity source | /v1.0/identitysources/{instanceId} |
/v2.0/identitysources/{instanceId} |
01 June 2025 |
| Update identity source | /v1.0/identitysources/{instanceId} |
/v2.0/identitysources/{instanceId} |
01 June 2025 |
| Get an identity source | /v1.0/identitysources/{instanceId} |
/v2.0/identitysources/{instanceId} |
01 June 2025 |
| Get all identity sources | /v1.0/identitysources |
/v2.0/identitysources |
01 June 2025 |
| Get all identity sources with the property | /v1.0/identitysources/property/{propertyName}/{propertyValue} |
/v2.0/identitysources/property/{propertyName}/{propertyValue} |
01 June 2025 |
| Get all identity sources with the specified password policy | /v1.0/identitysources/passwordPolicies |
/v2.0/identitysources/passwordPolicies |
01 June 2025 |
| App grant APIs | |||
| Application grants | /v1.0/appgrants | /v2.0/appgrants/app/{app-id} | 30 June 2024 |
| Application grant | /v1.0/appgrants/{grant-id} | /v2.0/appgrants/app/{app-id}/grant/{grant-id} | 30 June 2024 |
| Access policy APIs | |||
| Create an access policy | https://{tenant_url}/v3.0/policyvault/accesspolicy | https://{tenant_url}/v5.0/policyvault/accesspolicy | 23 Dec 2023 |
| Retrieve access policies | https://{tenant_url}/v3.0/policyvault/accesspolicy | https://{tenant_url}/v5.0/policyvault/accesspolicy | 23 Dec 2023 |
| Update an access policy | https://{tenant_url}/v3.0/policyvault/accesspolicy/{policyId} | https://{tenant_url}/v5.0/policyvault/accesspolicy/{policyId} | 23 Dec 2023 |
| Retrieve an access policy | https://{tenant_url}/v3.0/policyvault/accesspolicy/{policyId} | https://{tenant_url}/v5.0/policyvault/accesspolicy/{policyId} | 23 Dec 2023 |
| Delete an access policy | https://{tenant_url}/v3.0/policyvault/accesspolicy/{policyId} | https://{tenant_url}/v5.0/policyvault/accesspolicy/{policyId} | 23 Dec 2023 |
| Branding APIs | |||
| Download Template | /v1.0/branding/download | /v1.0/branding/themes | 30 June 2023 |
| Upload Template. | /v1.0/branding/upload | /v1.0/branding/themes | 30 June 2023 |
| Consent APIs | |||
| Manage application consents of apps that the user is an owner of. | /v1.0/appconsents | /config/v1.0/privacy/consents | 30 June 2022 |
| Manage tenant consents. | /v1.0/consents | /config/v1.0/privacy/consents | 30 June 2022 |
| Manage your own consents. | /v1.0/userconsents | /config/v1.0/privacy/consents | 30 June 2022 |
| Schema attributes APIs | |||
| Get schema attributes. | /v2.0/Schema/attributes | /v1.0/attributes | 31 May 2022 |
| Post schema attributes. | /v2.0/Schema/attributes | /v1.0/attributes | 31 May 2022 |
| Delete schema attributes {name} | /v2.0/Schema/attributes/{name} | /v1.0/attributes/{attrId} | 31 May 2022 |
| Get schema attributes {name} | /v2.0/Schema/attributes/{name} | /v1.0/attributes/{attrId} | 31 May 2022 |
| Put schema attributes {name} | /v2.0/Schema/attributes/{name} | /v1.0/attributes/{attrId} | 31 May 2022 |
| Authentication method APIs | |||
| Authentication Factors | /v1.0/authnmethods | /v2.0/factors | 31 December 2021 |
| Email One-time Password | /v1.0/authnmethods/emailotp | /v2.0/factors/emailotp | 31 December 2021 |
| SMS One-time Password | /v1.0/authnmethods/smsotp | /v2.0/factors/smsotp | 31 December 2021 |
| Time-based One-time Password | /v1.0/authnmethods/totp | /v2.0/factors/totp | 31 December 2021 |
| Authentication Methods | /v1.0/authnconfig/authnmethods/<type>/properties | /config/v2.0/factors/<type> | 31 December 2021 |
| Access Policy Management API | |||
| Access Policy Management | /v1.0/policyvault/<policytag> | /v3.0/policyvault/accesspolicy | 31 December 2021 |