developer.sailpoint.com/docs/tools/sdk/powershell/Reference/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
beta-auth-profile	AuthProfile	AuthProfile	AuthProfile	powershellsdk	powershell PowerShell sdk AuthProfile BetaAuthProfile	/tools/sdk/powershell/beta/methods/auth-profile	SDK Software Development Kit AuthProfile BetaAuthProfile

AuthProfile

Use this API to implement Auth Profile functionality. With this functionality in place, users can read authentication profiles and make changes to them.

An authentication profile represents an identity profile's authentication configuration. When the identity profile is created, its authentication profile is also created. An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies.

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.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the Auth Profile to get.

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

$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get.

# Get auth profile.

try {
    Get-BetaProfileConfig -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-BetaProfileConfig -Id $Id  
} 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.

API Spec

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

API Spec

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 = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] | 
 

# Patch a specified auth profile

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

[Back to top]