Skip to main content

AccessModelMetadataService

Use this API to create and manage metadata attributes for your Access Model. Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement, role, and access profile metadata.

Common usages for Access Model metadata include:

  • Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage.

  • Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights.

  • Identifying access that may requires additional approval requirements or be subject to more frequent review.

Every method returns an Observable. All request paths are relative to the baseUrl you pass to provideSailPoint().

MethodHTTP requestDescription
create-access-model-metadata-attribute-v1POST /access-model-metadata/v1/attributesCreate access model metadata attribute
create-access-model-metadata-attribute-value-v1POST /access-model-metadata/v1/attributes/{key}/valuesCreate access model metadata value
delete-access-model-metadata-attribute-v1DELETE /access-model-metadata/v1/attributes/{key}Delete access model metadata attribute
delete-access-model-metadata-attribute-value-v1DELETE /access-model-metadata/v1/attributes/{key}/values/{value}Delete access model metadata value
get-access-model-metadata-attribute-v1GET /access-model-metadata/v1/attributes/{key}Get access model metadata attribute
get-access-model-metadata-attribute-value-v1GET /access-model-metadata/v1/attributes/{key}/values/{value}Get access model metadata value
list-access-model-metadata-attribute-v1GET /access-model-metadata/v1/attributesList access model metadata attributes
list-access-model-metadata-attribute-value-v1GET /access-model-metadata/v1/attributes/{key}/valuesList access model metadata values
update-access-model-metadata-attribute-v1PATCH /access-model-metadata/v1/attributes/{key}Update access model metadata attribute
update-access-model-metadata-attribute-value-v1PATCH /access-model-metadata/v1/attributes/{key}/values/{value}Update access model metadata value
update-access-model-metadata-by-filter-v1POST /access-model-metadata/v1/bulk-update/filterMetadata Attribute update by filter
update-access-model-metadata-by-ids-v1POST /access-model-metadata/v1/bulk-update/idsMetadata Attribute update by ids
update-access-model-metadata-by-query-v1POST /access-model-metadata/v1/bulk-update/queryMetadata Attribute update by query

create-access-model-metadata-attribute-v1​

Create access model metadata attribute Create a new Access Model Metadata Attribute.

The isAdhoc field can be set on creation to indicate whether the Attribute supports ad-hoc (dynamically created) values in addition to static values; if omitted, it defaults to false.

Any values provided at creation time must each have a type of static (or omit/leave type blank); adhoc is not an allowed value on this public API and results in a 400 error. Ad-hoc values are created dynamically through an internal service-to-service flow, not through this API.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is CreateAccessModelMetadataAttributeV1RequestParams.

NameTypeDescriptionNotes
attributeDTOAttributeDTOAttribute to create

Return type​

Observable<AttributeDTO>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';
import { AttributeDTO } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  createAccessModelMetadataAttributeV1(): void {
    const attributeDTO: AttributeDTO = ; // Attribute to create
    this.api.createAccessModelMetadataAttributeV1({ attributeDTO: attributeDTO }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

create-access-model-metadata-attribute-value-v1​

Create access model metadata value Create a new value for an existing Access Model Metadata Attribute.

The type field must be omitted, blank, or static (case-insensitive); adhoc is not an allowed value on this public API and results in a 400 error. Ad-hoc values are created dynamically through an internal service-to-service flow when the parent Attribute has isAdhoc set to true, not through this API.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is CreateAccessModelMetadataAttributeValueV1RequestParams.

NameTypeDescriptionNotes
keystringTechnical name of the Attribute.[default to undefined]
attributeValueDTOAttributeValueDTOAttribute value to create

Return type​

Observable<AttributeValueDTO>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';
import { AttributeValueDTO } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  createAccessModelMetadataAttributeValueV1(): void {
    const key: string = ; // Technical name of the Attribute.
    const attributeValueDTO: AttributeValueDTO = ; // Attribute value to create
    this.api.createAccessModelMetadataAttributeValueV1({ key: key, attributeValueDTO: attributeValueDTO }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-access-model-metadata-attribute-v1​

Delete access model metadata attribute Delete an existing Access Model Metadata Attribute and all of its values.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is DeleteAccessModelMetadataAttributeV1RequestParams.

NameTypeDescriptionNotes
keystringTechnical name of the Attribute.[default to undefined]

Return type​

Observable<TrackerKeyDTO>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  deleteAccessModelMetadataAttributeV1(): void {
    const key: string = ; // Technical name of the Attribute.
    this.api.deleteAccessModelMetadataAttributeV1({ key: key }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

delete-access-model-metadata-attribute-value-v1​

Delete access model metadata value Delete an existing Access Model Metadata Attribute Value.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is DeleteAccessModelMetadataAttributeValueV1RequestParams.

NameTypeDescriptionNotes
keystringTechnical name of the Attribute.[default to undefined]
valuestringTechnical name of the Attribute value.[default to undefined]

Return type​

Observable<TrackerValueDTO>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  deleteAccessModelMetadataAttributeValueV1(): void {
    const key: string = ; // Technical name of the Attribute.
    const value: string = ; // Technical name of the Attribute value.
    this.api.deleteAccessModelMetadataAttributeValueV1({ key: key, value: value }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-access-model-metadata-attribute-v1​

Get access model metadata attribute Get single Access Model Metadata Attribute

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetAccessModelMetadataAttributeV1RequestParams.

NameTypeDescriptionNotes
keystringTechnical name of the Attribute.[default to undefined]

Return type​

Observable<AttributeDTO>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  getAccessModelMetadataAttributeV1(): void {
    const key: string = ; // Technical name of the Attribute.
    this.api.getAccessModelMetadataAttributeV1({ key: key }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

get-access-model-metadata-attribute-value-v1​

Get access model metadata value Get single Access Model Metadata Attribute Value

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is GetAccessModelMetadataAttributeValueV1RequestParams.

NameTypeDescriptionNotes
keystringTechnical name of the Attribute.[default to undefined]
valuestringTechnical name of the Attribute value.[default to undefined]

Return type​

Observable<AttributeValueDTO>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  getAccessModelMetadataAttributeValueV1(): void {
    const key: string = ; // Technical name of the Attribute.
    const value: string = ; // Technical name of the Attribute value.
    this.api.getAccessModelMetadataAttributeValueV1({ key: key, value: value }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-access-model-metadata-attribute-v1​

List access model metadata attributes Get a list of Access Model Metadata Attributes. Supports pagination through limit and offset parameters.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ListAccessModelMetadataAttributeV1RequestParams.

NameTypeDescriptionNotes
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: key: eq, co name: eq, co type: eq status: eq objectTypes: eq Supported composite operators are and, or[optional] [default to undefined]
sortersstringSort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: key, name, type, status[optional] [default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.[optional] [default to 0]
countbooleanIf 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​

Observable<Array<AttributeDTO>>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  listAccessModelMetadataAttributeV1(): void {
    const filters: string = ; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **key**: *eq, co*  **name**: *eq, co*  **type**: *eq*  **status**: *eq*  **objectTypes**: *eq*  Supported composite operators are *and, or* (optional)
    const sorters: string = ; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **key, name, type, status** (optional)
    const limit: number = ; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
    const offset: number = ; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
    const 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&#x3D;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)
    this.api.listAccessModelMetadataAttributeV1({  }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

list-access-model-metadata-attribute-value-v1​

List access model metadata values Get a list of Access Model Metadata Attribute Values. Supports pagination through limit and offset parameters.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is ListAccessModelMetadataAttributeValueV1RequestParams.

NameTypeDescriptionNotes
keystringTechnical name of the Attribute.[default to undefined]
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: value: eq, co name: eq, co status: eq type: eq Supported composite operators are and, or[optional] [default to undefined]
sortersstringSort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: value, name, status, type[optional] [default to undefined]
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.[optional] [default to 0]
countbooleanIf 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​

Observable<Array<AttributeValueDTO>>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  listAccessModelMetadataAttributeValueV1(): void {
    const key: string = ; // Technical name of the Attribute.
    const filters: string = ; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **value**: *eq, co*  **name**: *eq, co*  **status**: *eq*  **type**: *eq*  Supported composite operators are *and, or* (optional)
    const sorters: string = ; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **value, name, status, type** (optional)
    const limit: number = ; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
    const offset: number = ; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
    const 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&#x3D;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)
    this.api.listAccessModelMetadataAttributeValueV1({ key: key }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-access-model-metadata-attribute-v1​

Update access model metadata attribute Update an existing Access Model Metadata Attribute.
The following fields are patchable: name, description, multiselect, isAdhoc, values

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is UpdateAccessModelMetadataAttributeV1RequestParams.

NameTypeDescriptionNotes
keystringTechnical name of the Attribute.[default to undefined]
jsonPatchOperationArray<JsonPatchOperation>JSON Patch array to apply

Return type​

Observable<AttributeDTO>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';
import { JsonPatchOperation } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  updateAccessModelMetadataAttributeV1(): void {
    const key: string = ; // Technical name of the Attribute.
    const jsonPatchOperation: Array<JsonPatchOperation> = ; // JSON Patch array to apply
    this.api.updateAccessModelMetadataAttributeV1({ key: key, jsonPatchOperation: jsonPatchOperation }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-access-model-metadata-attribute-value-v1​

Update access model metadata value Update an existing Access Model Metadata Attribute Value.
The following fields are patchable: name

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is UpdateAccessModelMetadataAttributeValueV1RequestParams.

NameTypeDescriptionNotes
keystringTechnical name of the Attribute.[default to undefined]
valuestringTechnical name of the Attribute value.[default to undefined]
jsonPatchOperationArray<JsonPatchOperation>JSON Patch array to apply

Return type​

Observable<AttributeValueDTO>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';
import { JsonPatchOperation } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  updateAccessModelMetadataAttributeValueV1(): void {
    const key: string = ; // Technical name of the Attribute.
    const value: string = ; // Technical name of the Attribute value.
    const jsonPatchOperation: Array<JsonPatchOperation> = ; // JSON Patch array to apply
    this.api.updateAccessModelMetadataAttributeValueV1({ key: key, value: value, jsonPatchOperation: jsonPatchOperation }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-access-model-metadata-by-filter-v1​

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Metadata Attribute update by filter Bulk update Access Model Metadata Attribute Values using a filter

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is UpdateAccessModelMetadataByFilterV1RequestParams.

NameTypeDescriptionNotes
entitlementAttributeBulkUpdateFilterRequestEntitlementAttributeBulkUpdateFilterRequestAttribute metadata bulk update request body.

Return type​

Observable<AccessModelMetadataBulkUpdateResponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';
import { EntitlementAttributeBulkUpdateFilterRequest } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  updateAccessModelMetadataByFilterV1(): void {
    const entitlementAttributeBulkUpdateFilterRequest: EntitlementAttributeBulkUpdateFilterRequest = ; // Attribute metadata bulk update request body.
    this.api.updateAccessModelMetadataByFilterV1({ entitlementAttributeBulkUpdateFilterRequest: entitlementAttributeBulkUpdateFilterRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-access-model-metadata-by-ids-v1​

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Metadata Attribute update by ids Bulk update Access Model Metadata Attribute Values using ids.

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is UpdateAccessModelMetadataByIdsV1RequestParams.

NameTypeDescriptionNotes
entitlementAttributeBulkUpdateIdsRequestEntitlementAttributeBulkUpdateIdsRequestAttribute metadata bulk update request body.

Return type​

Observable<AccessModelMetadataBulkUpdateResponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';
import { EntitlementAttributeBulkUpdateIdsRequest } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  updateAccessModelMetadataByIdsV1(): void {
    const entitlementAttributeBulkUpdateIdsRequest: EntitlementAttributeBulkUpdateIdsRequest = ; // Attribute metadata bulk update request body.
    this.api.updateAccessModelMetadataByIdsV1({ entitlementAttributeBulkUpdateIdsRequest: entitlementAttributeBulkUpdateIdsRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]

update-access-model-metadata-by-query-v1​

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Metadata Attribute update by query Bulk update Access Model Metadata Attribute Values using a query

API Spec

Parameters​

The service takes one object that holds every parameter. Its type is UpdateAccessModelMetadataByQueryV1RequestParams.

NameTypeDescriptionNotes
entitlementAttributeBulkUpdateQueryRequestEntitlementAttributeBulkUpdateQueryRequestAttribute metadata bulk update request body.

Return type​

Observable<AccessModelMetadataBulkUpdateResponse>

HTTP request headers​

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

Example​

import { Component, inject } from '@angular/core';
import { AccessModelMetadataService } from '@sailpoint/angular-sdk/access_model_metadata';
import { EntitlementAttributeBulkUpdateQueryRequest } from '@sailpoint/angular-sdk/access_model_metadata';

@Component({ selector: 'app-example', template: '' })
export class ExampleComponent {
  private readonly api = inject(AccessModelMetadataService);

  updateAccessModelMetadataByQueryV1(): void {
    const entitlementAttributeBulkUpdateQueryRequest: EntitlementAttributeBulkUpdateQueryRequest = ; // Attribute metadata bulk update request body.
    this.api.updateAccessModelMetadataByQueryV1({ entitlementAttributeBulkUpdateQueryRequest: entitlementAttributeBulkUpdateQueryRequest }).subscribe({
      next: (result) => console.log(result),
      error: (error) => console.error(error),
    });
  }
}

[Back to top]