Files
developer.sailpoint.com/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md
2025-01-28 13:29:29 -05:00

9.1 KiB

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
beta-access-model-metadata AccessModelMetadata AccessModelMetadata AccessModelMetadata powershellsdk
powershell
PowerShell
sdk
AccessModelMetadata
BetaAccessModelMetadata
/tools/sdk/powershell/beta/methods/access-model-metadata
SDK
Software Development Kit
AccessModelMetadata
BetaAccessModelMetadata

AccessModelMetadata

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

Method HTTP request Description
Get-BetaAccessModelMetadataAttribute GET /access-model-metadata/attributes/{key} Get Access Model Metadata Attribute
Get-BetaAccessModelMetadataAttributeValue GET /access-model-metadata/attributes/{key}/values/{value} Get Access Model Metadata Value
Get-BetaAccessModelMetadataAttribute GET /access-model-metadata/attributes List Access Model Metadata Attributes
Get-BetaAccessModelMetadataAttributeValue GET /access-model-metadata/attributes/{key}/values List Access Model Metadata Values

get-access-model-metadata-attribute

Get single Access Model Metadata Attribute

Parameters

Param Type Name Data Type Required Description
Path Key String True Technical name of the Attribute.

Return type

AttributeDTO

Responses

Code Description Data Type
200 OK AttributeDTO
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too 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. ListAccessModelMetadataAttribute429Response
500 Internal 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-BetaAccessModelMetadataAttribute-BetaKey $Key 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAccessModelMetadataAttribute -BetaKey $Key  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-access-model-metadata-attribute-value

Get single Access Model Metadata Attribute Value

Parameters

Param Type Name Data Type Required Description
Path Key String True Technical name of the Attribute.
Path Value String True Technical name of the Attribute value.

Return type

AttributeValueDTO

Responses

Code Description Data Type
200 OK AttributeValueDTO
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too 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. ListAccessModelMetadataAttribute429Response
500 Internal 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-BetaAccessModelMetadataAttributeValue-BetaKey $Key -BetaValue $Value 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -BetaValue $Value  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-access-model-metadata-attribute

Get a list of Access Model Metadata Attributes

Parameters

Param Type Name Data Type Required Description
Query Filters String (optional) Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: name: eq type: eq status: eq objectTypes: eq Supported composite operators: and

Return type

AttributeDTO[]

Responses

Code Description Data Type
200 OK AttributeDTO[]
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too 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. ListAccessModelMetadataAttribute429Response
500 Internal 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:  **name**: *eq*  **type**: *eq*  **status**: *eq*  **objectTypes**: *eq*  Supported composite operators: *and* (optional)
# List Access Model Metadata Attributes
try {
    Get-BetaAccessModelMetadataAttribute
    
    # Below is a request that includes all optional parameters
    # Get-BetaAccessModelMetadataAttribute -BetaFilters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-access-model-metadata-attribute-value

Get a list of Access Model Metadata Attribute Values

Parameters

Param Type Name Data Type Required Description
Path Key String True Technical name of the Attribute.

Return type

AttributeValueDTO[]

Responses

Code Description Data Type
200 OK AttributeValueDTO[]
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too 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. ListAccessModelMetadataAttribute429Response
500 Internal 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.
# List Access Model Metadata Values
try {
    Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue"
    Write-Host $_.ErrorDetails
}

[Back to top]