IdentitiesService

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

Methods	Description
listEnrichedIdentities	Returns all Identities with enriched metadata in the org
createIdentity	Creates a new identity. An identity represents a human, service, or workload.
getIdentity	Returns the details of an identity.
updateIdentity	Updates an identity.
deleteIdentity	Deletes the specified identity.

listEnrichedIdentities

Returns all Identities with enriched metadata in the org

• HTTP Method: GET
• Endpoint: /identities

Return Type

List<Identity>

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.Identity;
import java.util.List;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val response: List<Identity> = testSdk.identities.listEnrichedIdentities();
    
    println(response);
}

createIdentity

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

• HTTP Method: POST
• Endpoint: /identities

Parameters

Name	Type	Required	Description
identityParams	IdentityParams	✅	Request Body

Return Type

Identity

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.Identity;
import com.swagger.petstore.models.IdentityParams;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val identityParams: IdentityParams = IdentityParams.builder()
			.abbeyAccount("abbey_account")
			.source("source")
			.metadata("metadata")
			.build();

    val response: Identity = testSdk.identities.createIdentity(identityParams);
    
    println(response);
}

getIdentity

Returns the details of an identity.

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

Parameters

Name	Type	Required	Description
identityId	String	✅	The ID of the identity to retrieve

Return Type

Identity

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.Identity;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val response: Identity = testSdk.identities.getIdentity("identity_id");
    
    println(response);
}

updateIdentity

Updates an identity.

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

Parameters

Name	Type	Required	Description
identityId	String	✅	The ID of the identity to retrieve
identityParams	IdentityParams	✅	Request Body

Return Type

Identity

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;
import com.swagger.petstore.models.Identity;
import com.swagger.petstore.models.IdentityParams;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    val identityParams: IdentityParams = IdentityParams.builder()
			.abbeyAccount("abbey_account")
			.source("source")
			.metadata("metadata")
			.build();

    val response: Identity = testSdk.identities.updateIdentity("identity_id", identityParams);
    
    println(response);
}

deleteIdentity

Deletes the specified identity.

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

Parameters

Name	Type	Required	Description
identityId	String	✅	The ID of the identity to delete

Example Usage Code Snippet

import com.swagger.petstore.TestSdk;
import com.swagger.petstore.config.TestSdkConfig;

fun main() {
	val config: TestSdkConfig = TestSdkConfig.builder()
			.accessToken("YOUR_ACCESS_TOKEN")
			.build();

    val testSdk: TestSdk = TestSdk(config);

    testSdk.identities.deleteIdentity("identity_id");
}