IdentityAttributesApi

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-identity-attribute-v1	POST /identity-attributes/v1	Create identity attribute
delete-identity-attribute-v1	DELETE /identity-attributes/v1/{name}	Delete identity attribute
delete-identity-attributes-in-bulk-v1	DELETE /identity-attributes/v1/bulk-delete	Bulk delete identity attributes
get-identity-attribute-v1	GET /identity-attributes/v1/{name}	Get identity attribute
list-identity-attributes-v1	GET /identity-attributes/v1	List identity attributes
put-identity-attribute-v1	PUT /identity-attributes/v1/{name}	Update identity attribute

create-identity-attribute-v1

Create identity attribute Use this API to create a new identity attribute.

API Spec

Parameters

Name	Type	Description	Notes
identityattribute2	Identityattribute2

Return type

Identityattribute2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { IdentityAttributesApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IdentityAttributesApi(configuration);
const identityattribute2: Identityattribute2 = ; // 
const result = await apiInstance.createIdentityAttributeV1({ identityattribute2: identityattribute2 });
console.log(result);

[Back to top]

delete-identity-attribute-v1

Delete identity attribute This deletes an identity attribute with the given name. The system and standard properties must be set to false before you can delete an identity attribute.

API Spec

Parameters

Name	Type	Description	Notes
name	string	The attribute's technical name.	[default to undefined]

Return type

(empty response body)

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { IdentityAttributesApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IdentityAttributesApi(configuration);
const name: string = displayName; // The attribute\'s technical name.
const result = await apiInstance.deleteIdentityAttributeV1({ name: name });
console.log(result);

[Back to top]

delete-identity-attributes-in-bulk-v1

Bulk delete identity attributes Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The system and standard properties must be set to 'false' before you can delete an identity attribute.

API Spec

Parameters

Name	Type	Description	Notes
identityattributenames	Identityattributenames

Return type

(empty response body)

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { IdentityAttributesApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IdentityAttributesApi(configuration);
const identityattributenames: Identityattributenames = ; // 
const result = await apiInstance.deleteIdentityAttributesInBulkV1({ identityattributenames: identityattributenames });
console.log(result);

[Back to top]

get-identity-attribute-v1

Get identity attribute This gets an identity attribute for a given technical name.

API Spec

Parameters

Name	Type	Description	Notes
name	string	The attribute's technical name.	[default to undefined]

Return type

Identityattribute2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { IdentityAttributesApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IdentityAttributesApi(configuration);
const name: string = displayName; // The attribute\'s technical name.
const result = await apiInstance.getIdentityAttributeV1({ name: name });
console.log(result);

[Back to top]

list-identity-attributes-v1

List identity attributes Use this API to get a collection of identity attributes.

API Spec

Parameters

Name	Type	Description	Notes
includeSystem	boolean	Include 'system' attributes in the response.	[optional] [default to false]
includeSilent	boolean	Include 'silent' attributes in the response.	[optional] [default to false]
searchableOnly	boolean	Include only 'searchable' attributes in the response.	[optional] [default to false]
count	boolean	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]

Return type

Array<Identityattribute2>

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { IdentityAttributesApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IdentityAttributesApi(configuration);
const includeSystem: boolean = false; // Include \'system\' attributes in the response. (optional)
const includeSilent: boolean = false; // Include \'silent\' attributes in the response. (optional)
const searchableOnly: boolean = false; // Include only \'searchable\' attributes in the response. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const result = await apiInstance.listIdentityAttributesV1({  });
console.log(result);

[Back to top]

put-identity-attribute-v1

Update identity attribute This updates an existing identity attribute. Making an attribute searchable requires that the system, standard, and multi properties be set to false.

API Spec

Parameters

Name	Type	Description	Notes
name	string	The attribute's technical name.	[default to undefined]
identityattribute2	Identityattribute2

Return type

Identityattribute2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { IdentityAttributesApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IdentityAttributesApi(configuration);
const name: string = displayName; // The attribute\'s technical name.
const identityattribute2: Identityattribute2 = ; // 
const result = await apiInstance.putIdentityAttributeV1({ name: name, identityattribute2: identityattribute2 });
console.log(result);

[Back to top]