developer.sailpoint.com/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAuthProfileApi.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
auth-profile	AuthProfile	AuthProfile	AuthProfile	powershellsdk	powershell PowerShell sdk AuthProfile	/tools/sdk/powershell/beta/methods/auth-profile	SDK Software Development Kit AuthProfile

AuthProfile

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

Method	HTTP request	Description
Get-BetaProfileConfig	GET /auth-profiles/{id}	Get Auth Profile.
Get-BetaProfileConfigList	GET /auth-profiles	Get list of Auth Profiles.
Update-BetaProfileConfig	PATCH /auth-profiles/{id}	Patch a specified Auth Profile

get-profile-config

This API returns auth profile information.

Parameters

Param Type	Name	Data Type	Required	Description

Return type

AuthProfile

Responses

Code	Description	Data Type
200	Auth Profile	AuthProfile
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
404	Not Found - returned if the request URL refers to a resource or object that does not exist	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

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

[Back to top]

get-profile-config-list

This API returns a list of auth profiles.

Parameters

Param Type	Name	Data Type	Required	Description

Return type

AuthProfileSummary[]

Responses

Code	Description	Data Type
200	List of Auth Profiles	AuthProfileSummary[]
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

# Get list of Auth Profiles.
try {
    Get-BetaProfileConfigList
    
    # Below is a request that includes all optional parameters
    # Get-BetaProfileConfigList  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList"
    Write-Host $_.ErrorDetails
}

[Back to top]

patch-profile-config

This API updates an existing Auth Profile. The following fields are patchable: offNetwork, untrustedGeography, applicationId, applicationName, type

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the Auth Profile to patch.
Body	JsonPatchOperation	[]JsonPatchOperation	True

Return type

AuthProfile

Responses

Code	Description	Data Type
200	Responds with the Auth Profile as updated.	AuthProfile
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: application/json-patch+json
• Accept: application/json

Example

$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch.
 # JsonPatchOperation[] | 
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ 

# Patch a specified Auth Profile
try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-BetaProfileConfig-BetaId $Id -BetaJsonPatchOperation $Result
    
    # Below is a request that includes all optional parameters
    # Update-BetaProfileConfig -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]