Skip to main content

AccessModelMetadata

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 metadata. Support for role and access profile metadata will be introduced in a subsequent release.

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.

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

MethodHTTP requestDescription
New-AccessModelMetadataAttributeV1POST /access-model-metadata/v1/attributesCreate access model metadata attribute
New-AccessModelMetadataAttributeValueV1POST /access-model-metadata/v1/attributes/{key}/valuesCreate access model metadata value
Get-AccessModelMetadataAttributeV1GET /access-model-metadata/v1/attributes/{key}Get access model metadata attribute
Get-AccessModelMetadataAttributeValueV1GET /access-model-metadata/v1/attributes/{key}/values/{value}Get access model metadata value
Get-AccessModelMetadataAttributeV1GET /access-model-metadata/v1/attributesList access model metadata attributes
Get-AccessModelMetadataAttributeValueV1GET /access-model-metadata/v1/attributes/{key}/valuesList access model metadata values
Update-AccessModelMetadataAttributeV1PATCH /access-model-metadata/v1/attributes/{key}Update access model metadata attribute
Update-AccessModelMetadataAttributeValueV1PATCH /access-model-metadata/v1/attributes/{key}/values/{value}Update access model metadata value
Update-AccessModelMetadataByFilterV1POST /access-model-metadata/v1/bulk-update/filterMetadata Attribute update by filter
Update-AccessModelMetadataByIdsV1POST /access-model-metadata/v1/bulk-update/idsMetadata Attribute update by ids
Update-AccessModelMetadataByQueryV1POST /access-model-metadata/v1/bulk-update/queryMetadata Attribute update by query

create-access-model-metadata-attribute-v1

Create a new Access Model Metadata Attribute.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
BodyAttributedtoAttributedtoTrueAttribute to create

Return type

Attributedto

Responses

CodeDescriptionData Type
201CreatedAttributedto
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Attributedto = @""@

# Create access model metadata attribute

try {
$Result = ConvertFrom-JsonToAttributedto -Json $Attributedto
New-AccessModelMetadataAttributeV1 -Attributedto $Result

# Below is a request that includes all optional parameters
# New-AccessModelMetadataAttributeV1 -Attributedto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessModelMetadataAttributeV1"
Write-Host $_.ErrorDetails
}

[Back to top]

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

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

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathKeyStringTrueTechnical name of the Attribute.
BodyAttributevaluedtoAttributevaluedtoTrueAttribute value to create

Return type

Attributevaluedto

Responses

CodeDescriptionData Type
201CreatedAttributevaluedto
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Key = "iscPrivacy" # String | Technical name of the Attribute.
$Attributevaluedto = @""@

# Create access model metadata value

try {
$Result = ConvertFrom-JsonToAttributevaluedto -Json $Attributevaluedto
New-AccessModelMetadataAttributeValueV1 -Key $Key -Attributevaluedto $Result

# Below is a request that includes all optional parameters
# New-AccessModelMetadataAttributeValueV1 -Key $Key -Attributevaluedto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessModelMetadataAttributeValueV1"
Write-Host $_.ErrorDetails
}

[Back to top]

get-access-model-metadata-attribute-v1

Get single Access Model Metadata Attribute

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathKeyStringTrueTechnical name of the Attribute.

Return type

Attributedto

Responses

CodeDescriptionData Type
200OKAttributedto
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Key = "iscPrivacy" # String | Technical name of the Attribute.

# Get access model metadata attribute

try {
Get-AccessModelMetadataAttributeV1 -Key $Key

# Below is a request that includes all optional parameters
# Get-AccessModelMetadataAttributeV1 -Key $Key
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessModelMetadataAttributeV1"
Write-Host $_.ErrorDetails
}

[Back to top]

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

Get single Access Model Metadata Attribute Value

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathKeyStringTrueTechnical name of the Attribute.
PathValueStringTrueTechnical name of the Attribute value.

Return type

Attributevaluedto

Responses

CodeDescriptionData Type
200OKAttributevaluedto
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Key = "iscPrivacy" # String | Technical name of the Attribute.
$Value = "public" # String | Technical name of the Attribute value.

# Get access model metadata value

try {
Get-AccessModelMetadataAttributeValueV1 -Key $Key -Value $Value

# Below is a request that includes all optional parameters
# Get-AccessModelMetadataAttributeValueV1 -Key $Key -Value $Value
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessModelMetadataAttributeValueV1"
Write-Host $_.ErrorDetails
}

[Back to top]

list-access-model-metadata-attribute-v1

Get a list of Access Model Metadata Attributes

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
QueryFiltersString(optional)Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: key: eq name: eq type: eq status: eq objectTypes: eq Supported composite operators are and, or
QuerySortersString(optional)Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, key
QueryLimitInt32(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.
QueryCountBoolean(optional) (default to $false)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.

Return type

Attributedto[]

Responses

CodeDescriptionData Type
200OKAttributedto[]
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Filters = 'name eq "Privacy"' # 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*  **name**: *eq*  **type**: *eq*  **status**: *eq*  **objectTypes**: *eq*  Supported composite operators are *and, or* (optional)
$Sorters = "name,-key" # 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: **name, key** (optional)
$Limit = 250 # Int32 | 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) (default to 250)
$Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)

# List access model metadata attributes

try {
Get-AccessModelMetadataAttributeV1

# Below is a request that includes all optional parameters
# Get-AccessModelMetadataAttributeV1 -Filters $Filters -Sorters $Sorters -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessModelMetadataAttributeV1"
Write-Host $_.ErrorDetails
}

[Back to top]

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

Get a list of Access Model Metadata Attribute Values

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathKeyStringTrueTechnical name of the Attribute.
QueryLimitInt32(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.
QueryCountBoolean(optional) (default to $false)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.

Return type

Attributevaluedto[]

Responses

CodeDescriptionData Type
200OKAttributevaluedto[]
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Key = "iscPrivacy" # String | Technical name of the Attribute.
$Limit = 250 # Int32 | 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) (default to 250)
$Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)

# List access model metadata values

try {
Get-AccessModelMetadataAttributeValueV1 -Key $Key

# Below is a request that includes all optional parameters
# Get-AccessModelMetadataAttributeValueV1 -Key $Key -Limit $Limit -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessModelMetadataAttributeValueV1"
Write-Host $_.ErrorDetails
}

[Back to top]

update-access-model-metadata-attribute-v1

Update an existing Access Model Metadata Attribute.
The following fields are patchable: name, description, multiselect, values

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathKeyStringTrueTechnical name of the Attribute.
BodyJsonpatchoperation[]JsonpatchoperationTrueJSON Patch array to apply

Return type

Attributedto

Responses

CodeDescriptionData Type
200OK - Attribute updated successfullyAttributedto
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Key = "iscPrivacy" # String | Technical name of the Attribute.
$Jsonpatchoperation = @""@ # Jsonpatchoperation[] | JSON Patch array to apply


# Update access model metadata attribute

try {
$Result = ConvertFrom-JsonToJsonpatchoperation -Json $Jsonpatchoperation
Update-AccessModelMetadataAttributeV1 -Key $Key -Jsonpatchoperation $Result

# Below is a request that includes all optional parameters
# Update-AccessModelMetadataAttributeV1 -Key $Key -Jsonpatchoperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessModelMetadataAttributeV1"
Write-Host $_.ErrorDetails
}

[Back to top]

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

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

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathKeyStringTrueTechnical name of the Attribute.
PathValueStringTrueTechnical name of the Attribute value.
BodyJsonpatchoperation[]JsonpatchoperationTrueJSON Patch array to apply

Return type

Attributevaluedto

Responses

CodeDescriptionData Type
200OK - Attribute value updated successfullyAttributevaluedto
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Key = "iscPrivacy" # String | Technical name of the Attribute.
$Value = "public" # String | Technical name of the Attribute value.
$Jsonpatchoperation = @""@ # Jsonpatchoperation[] | JSON Patch array to apply


# Update access model metadata value

try {
$Result = ConvertFrom-JsonToJsonpatchoperation -Json $Jsonpatchoperation
Update-AccessModelMetadataAttributeValueV1 -Key $Key -Value $Value -Jsonpatchoperation $Result

# Below is a request that includes all optional parameters
# Update-AccessModelMetadataAttributeValueV1 -Key $Key -Value $Value -Jsonpatchoperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessModelMetadataAttributeValueV1"
Write-Host $_.ErrorDetails
}

[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.

Bulk update Access Model Metadata Attribute Values using a filter

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
BodyEntitlementattributebulkupdatefilterrequestEntitlementattributebulkupdatefilterrequestTrueAttribute metadata bulk update request body.

Return type

Accessmodelmetadatabulkupdateresponse

Responses

CodeDescriptionData Type
200OKAccessmodelmetadatabulkupdateresponse
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Entitlementattributebulkupdatefilterrequest = @""@

# Metadata Attribute update by filter

try {
$Result = ConvertFrom-JsonToEntitlementattributebulkupdatefilterrequest -Json $Entitlementattributebulkupdatefilterrequest
Update-AccessModelMetadataByFilterV1 -Entitlementattributebulkupdatefilterrequest $Result

# Below is a request that includes all optional parameters
# Update-AccessModelMetadataByFilterV1 -Entitlementattributebulkupdatefilterrequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessModelMetadataByFilterV1"
Write-Host $_.ErrorDetails
}

[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.

Bulk update Access Model Metadata Attribute Values using ids.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
BodyEntitlementattributebulkupdateidsrequestEntitlementattributebulkupdateidsrequestTrueAttribute metadata bulk update request body.

Return type

Accessmodelmetadatabulkupdateresponse

Responses

CodeDescriptionData Type
200OKAccessmodelmetadatabulkupdateresponse
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Entitlementattributebulkupdateidsrequest = @""@

# Metadata Attribute update by ids

try {
$Result = ConvertFrom-JsonToEntitlementattributebulkupdateidsrequest -Json $Entitlementattributebulkupdateidsrequest
Update-AccessModelMetadataByIdsV1 -Entitlementattributebulkupdateidsrequest $Result

# Below is a request that includes all optional parameters
# Update-AccessModelMetadataByIdsV1 -Entitlementattributebulkupdateidsrequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessModelMetadataByIdsV1"
Write-Host $_.ErrorDetails
}

[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.

Bulk update Access Model Metadata Attribute Values using a query

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
BodyEntitlementattributebulkupdatequeryrequestEntitlementattributebulkupdatequeryrequestTrueAttribute metadata bulk update request body.

Return type

Accessmodelmetadatabulkupdateresponse

Responses

CodeDescriptionData Type
200OKAccessmodelmetadatabulkupdateresponse
400Client Error - Returned if the request body is invalid.Errorresponsedto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttributeV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.Errorresponsedto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttributeV1429Response
500Internal Server Error - Returned if there is an unexpected error.Errorresponsedto

HTTP request headers

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

Example

$Entitlementattributebulkupdatequeryrequest = @""@

# Metadata Attribute update by query

try {
$Result = ConvertFrom-JsonToEntitlementattributebulkupdatequeryrequest -Json $Entitlementattributebulkupdatequeryrequest
Update-AccessModelMetadataByQueryV1 -Entitlementattributebulkupdatequeryrequest $Result

# Below is a request that includes all optional parameters
# Update-AccessModelMetadataByQueryV1 -Entitlementattributebulkupdatequeryrequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessModelMetadataByQueryV1"
Write-Host $_.ErrorDetails
}

[Back to top]