IdentitiesService

A list of all methods in the IdentitiesService service. Click on the method name to view detailed information about that method.

Methods	Description
list_enriched_identities	Returns all Identities with enriched metadata in the org
create_identity	Creates a new identity. An identity represents a human, service, or workload.
get_identity	Returns the details of an identity.
update_identity	Updates an identity.
delete_identity	Deletes the specified identity.

list_enriched_identities

Returns all Identities with enriched metadata in the org

• HTTP Method: GET
• Endpoint: /identities

Return Type

List[Identity]

Example Usage Code Snippet

from test_sdk import TestSdk

sdk = TestSdk(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.identities.list_enriched_identities()

print(result)

create_identity

Creates a new identity. An identity represents a human, service, or workload.

• HTTP Method: POST
• Endpoint: /identities

Parameters

Name	Type	Required	Description
request_body	IdentityParams	✅	The request body.

Return Type

Identity

Example Usage Code Snippet

from test_sdk import TestSdk
from test_sdk.models import IdentityParams

sdk = TestSdk(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = IdentityParams(
    abbey_account="abbey_account",
    source="source",
    metadata="metadata"
)

result = sdk.identities.create_identity(request_body=request_body)

print(result)

get_identity

Returns the details of an identity.

• HTTP Method: GET
• Endpoint: /identities/{identity_id}

Parameters

Name	Type	Required	Description
identity_id	str	✅	The ID of the identity to retrieve

Return Type

Identity

Example Usage Code Snippet

from test_sdk import TestSdk

sdk = TestSdk(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.identities.get_identity(identity_id="identity_id")

print(result)

update_identity

Updates an identity.

• HTTP Method: PUT
• Endpoint: /identities/{identity_id}

Parameters

Name	Type	Required	Description
request_body	IdentityParams	✅	The request body.
identity_id	str	✅	The ID of the identity to retrieve

Return Type

Identity

Example Usage Code Snippet

from test_sdk import TestSdk
from test_sdk.models import IdentityParams

sdk = TestSdk(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = IdentityParams(
    abbey_account="abbey_account",
    source="source",
    metadata="metadata"
)

result = sdk.identities.update_identity(
    request_body=request_body,
    identity_id="identity_id"
)

print(result)

delete_identity

Deletes the specified identity.

• HTTP Method: DELETE
• Endpoint: /identities/{identity_id}

Parameters

Name	Type	Required	Description
identity_id	str	✅	The ID of the identity to delete

Example Usage Code Snippet

from test_sdk import TestSdk

sdk = TestSdk(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.identities.delete_identity(identity_id="identity_id")

print(result)