All pages
Powered by GitBook
1 of 1

Loading...

List by Action Type

Find lifecycle management datasources that support specific action types and entity relationships

Endpoint

GET /api/v1/providers/datasources/lifecycle_managers:by_action_type

Description

Returns Lifecycle Management datasources filtered by their supported action types, entity types, and relationship types. This endpoint helps you find datasources that can perform specific lifecycle management operations.

API Reference

Query Parameters

Parameter
Type
Required?
Description

Action Type Values

Value
Name

Request Examples

Response Examples

Standard Response:

WRITE_BACK_EMAIL

7

PAUSE

8

SEND_NOTIFICATION

9

CUSTOM_ACTION

10

CREATE_ENTITLEMENT

11

CREATE_ACCESS_REVIEW

12

RESET_PASSWORD

13

DELETE_IDENTITY

action_type

integer

Optional

Filter by specific LCM action type. See Action Type Values below. See OpenAPI schema for details.

entity_type

string

Optional

Filter by entity type that the datasource can work with

relationship_type

string

Optional

0

NONE

1

SYNC_IDENTITIES

2

MANAGE_RELATIONSHIPS

3

CREATE_EMAIL

4

DEPROVISION_IDENTITY

5

ACCESS_PLAN

# Find datasources that support SYNC_IDENTITIES operations (action_type=1)
curl -X GET "$BASE_URL/api/v1/providers/datasources/lifecycle_managers:by_action_type?action_type=1" \
  -H "authorization: Bearer $VEZA_TOKEN"
# Find datasources that can manage User entities
curl -X GET "$BASE_URL/api/v1/providers/datasources/lifecycle_managers:by_action_type?entity_type=User" \
  -H "authorization: Bearer $VEZA_TOKEN"
# Find datasources that support SYNC_IDENTITIES operations on Users with MemberOf relationships
curl -X GET "$BASE_URL/api/v1/providers/datasources/lifecycle_managers:by_action_type?action_type=1&entity_type=User&relationship_type=MemberOf" \
  -H "authorization: Bearer $VEZA_TOKEN"
{
  "values": [
    {
      "id": "549a4b5e-0328-4c87-a19d-ee8a2926d1aa",
      "name": "Workday Integration",
      "provider_type": "WORKDAY",
      "external_id": "https://wd5-impl-services1.workday.com/veza_preview",
      "lifecycle_management_enabled": true,
      "supported_capabilities": [
        "IDENTITY_SOURCE",
        "ACCESS_TARGET"
      ]
    }
  ],
  "has_more": false,
  "next_page_token": ""
}

Filter by relationship type that the datasource can manage

6

Authentication Required

This endpoint requires a valid Veza API key for authentication.

See Authentication for more about creating and managing API keys.

All requests must include the API key as a Bearer token in the Authorization header.

Example:

curl -X GET "$BASE_URL/api/preview/keys" \
  -H "authorization: Bearer $VEZA_TOKEN"
get
Authorizations
Query parameters
action_typeinteger ยท enumOptional
entity_typestringOptional
relationship_typestringOptional
Responses
200

OK

application/json
default

Default error response

application/json
get
{
  "values": [
    {
      "id": "text",
      "enabled": true,
      "datasource": {},
      "definition": {
        "source_of_identity_definition": {
          "entity_type": "text"
        },
        "actions": [
          {
            "type": 1,
            "idempotent": true,
            "input_entity_types": [
              {
                "name": "text",
                "description": "text",
                "available_entity_types": [
                  "text"
                ]
              }
            ],
            "output_entity_types": [
              {
                "name": "text",
                "description": "text",
                "available_entity_types": [
                  "text"
                ]
              }
            ],
            "definition": {
              "@type": "text",
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      }
    }
  ]
}
GET /api/v1/providers/datasources/lifecycle_managers:by_action_type HTTP/1.1
Host: your-tenant.cookiecloud.ai
Authorization: Bearer JWT
Accept: */*