developer.sailpoint.com/docs/tools/sdk/powershell/refrence/v2024/Methods/V2024AuthUsersApi.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-users	AuthUsers	AuthUsers	AuthUsers	powershellsdk	powershell PowerShell sdk AuthUsers	/tools/sdk/powershell/v2024/methods/auth-users	SDK Software Development Kit AuthUsers

AuthUsers

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

Method	HTTP request	Description
Get-V2024AuthUser	GET /auth-users/{id}	Auth User Details
Update-V2024AuthUser	PATCH /auth-users/{id}	Auth User Update

get-auth-user

Return the specified user's authentication system details.

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	Identity ID

Return type

AuthUser

Responses

Code	Description	Data Type
200	The specified user's authentication system details.	AuthUser
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.	ListAccessProfiles401Response
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.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
# Auth User Details
try {
    Get-V2024AuthUser-V2024Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2024AuthUser -V2024Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser"
    Write-Host $_.ErrorDetails
}

[Back to top]

patch-auth-user

Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields:

• capabilities

A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed.

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	Identity ID
Body	JsonPatchOperation	[]JsonPatchOperation	True	A list of auth user update operations according to the JSON Patch standard.

Return type

AuthUser

Responses

Code	Description	Data Type
200	Auth user updated.	AuthUser
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.	ListAccessProfiles401Response
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.	ListAccessProfiles429Response
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 = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
 # JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ 

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

[Back to top]