MachineAccountCreationRequest
Use this API to submit and retrieve machine account creation requests.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| New-MachineAccountRequestV1 | POST /account-requests/v1/machine-account-create | Submit Machine Account Creation Request |
| New-MachineAccountRequestV2 | POST /account-requests/v2/machine-account-create | Machine Account Creation Request (v2) |
| New-MachineAccountV2 | POST /machine-accounts/v2/machine-account-create | Create Machine Account (v2) |
| Get-CreateMachineAccountRequestV1 | GET /account-requests/v1/machine-account-create/{accountRequestId} | Get Machine Account Creation Request |
| Get-MachineAccountCreateAccessInfoV1 | GET /source-subtypes/v1/machine-account-create-access | Machine Account Create Access |
create-machine-account-request-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Initiates machine account creation request for the specified subtype. This method validates the input data, processes the machine account creation request, and generates an asynchronous result containing a tracking ID.
NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| XSailPointExperimental | String | True (default to "true") | Use this header to enable this experimental API. | |
| Body | MachineAccountCreateRequestInput | MachineAccountCreateRequestInput | True |
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 202 | Machine account creation request result. | AccountRequestAsyncResult |
| 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. | CreateMachineAccountRequestV1401Response |
| 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. | CreateMachineAccountRequestV1429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$MachineAccountCreateRequestInput = @"{
"formId" : "f5dd23fe-3414-42b7-bb1c-869400ad7a10",
"entitlementIds" : [ "6d28b7c1620c49c6b6d5cbf81eb4b5fa", "2c91808a7624751a01762f19d67c220e" ],
"environment" : "Dev",
"description" : "Requesting machine account for tracking the inventory.",
"machineIdentityId" : "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa",
"ownerIdentityId" : "18104e7e499b4e23882d6323344ab6bc",
"userInput" : {
"target" : "AD Source",
"description" : "Inventory tracking"
},
"subtypeId" : "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa"
}"@
# Submit Machine Account Creation Request
try {
$Result = ConvertFrom-JsonToMachineAccountCreateRequestInput -Json $MachineAccountCreateRequestInput
New-MachineAccountRequestV1 -XSailPointExperimental $XSailPointExperimental -MachineAccountCreateRequestInput $Result
# Below is a request that includes all optional parameters
# New-MachineAccountRequestV1 -XSailPointExperimental $XSailPointExperimental -MachineAccountCreateRequestInput $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-MachineAccountRequestV1"
Write-Host $_.ErrorDetails
}
create-machine-account-request-v2
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Initiates a machine account creation request. The same body and process are used by POST /machine-accounts/v2/machine-account-create.
sourceId is required while tiered subtype configuration is enabled, and subtypeId must then be in that source's effective set. When that flag is off, sourceId is ignored and the source is the subtype's own source. entitlements is honored while per-entitlement request details are enabled; entitlementIds is honored while that flag is off. A non-empty list of the other kind returns 400. At most 20 unique entitlement ids are allowed.
The call returns 202 with accountRequestId. Poll GET /account-requests/v1/machine-account-create/{accountRequestId} for status. There is no v2 status route.
Missing subtypeId or ownerIdentityId, or a missing sourceId while tiered subtype configuration is enabled, returns 400. An unknown owner, source, or subtype returns 404. A subtype that is not in the source effective set returns 400. The endpoint returns 404 when both tiered subtype configuration and per-entitlement request details are disabled.
The caller must be authenticated with the sp:scopes:default scope. The create machine account entitlement for the subtype is checked when the request is processed. Without that entitlement the API returns 403.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| XSailPointExperimental | String | True (default to "true") | Use this header to enable this experimental API. | |
| Body | MachineAccountCreateRequestInputV2 | MachineAccountCreateRequestInputV2 | True |
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 202 | Machine account creation request accepted. | AccountRequestAsyncResult |
| 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. | CreateMachineAccountRequestV1401Response |
| 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. | CreateMachineAccountRequestV1429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$MachineAccountCreateRequestInputV2 = @"{
"sourceId" : "2c9180907c1e4b3a017c1e5f2a3b0001",
"formId" : "4f1bb61b-a0ab-4c0a-b9fb-20f44407b75a",
"entitlements" : [ {
"id" : "858d2151-ff19-464b-ae0d-6938b3af2baf",
"comment" : "Needed to read the reconciliation staging tables.",
"startDate" : "2026-09-01T00:00:00.000Z",
"removeDate" : "2027-03-01T00:00:00.000Z"
}, {
"id" : "0c7a44b9-3e21-4f88-9a10-77bd2c6e5f31"
} ],
"entitlementIds" : [ "858d2151-ff19-464b-ae0d-6938b3af2baf", "0c7a44b9-3e21-4f88-9a10-77bd2c6e5f31" ],
"environment" : "production",
"description" : "Nightly reconciliation job",
"machineIdentityId" : "b1e2c3d4-0a5b-4c6d-8e7f-9a0b1c2d3e4f",
"ownerIdentityId" : "9f2c1b7e4a6d4c8fa1b2c3d4e5f60718",
"userInput" : {
"accountName" : "svc-recon-01"
},
"subtypeId" : "1419fc28-a8ed-4a07-9f5c-0cb5dfad6311"
}"@
# Machine Account Creation Request (v2)
try {
$Result = ConvertFrom-JsonToMachineAccountCreateRequestInputV2 -Json $MachineAccountCreateRequestInputV2
New-MachineAccountRequestV2 -XSailPointExperimental $XSailPointExperimental -MachineAccountCreateRequestInputV2 $Result
# Below is a request that includes all optional parameters
# New-MachineAccountRequestV2 -XSailPointExperimental $XSailPointExperimental -MachineAccountCreateRequestInputV2 $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-MachineAccountRequestV2"
Write-Host $_.ErrorDetails
}
create-machine-account-v2
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Submits a machine account creation request. New integrations should use this operation. This operation accepts the same request and runs the same creation process as Submit Machine Account Creation Request. That operation stays on the account-requests API for integrations that already call it. When version 1 cannot create the account because the subtype is not tied to a single source, the error directs the caller here. This method validates the input data, processes the machine account creation request, and returns an asynchronous result containing a tracking ID.
Compared with v1, this version:
- Accepts a
sourceIdso you can choose the source to create the account on.sourceIdis required while tiered subtype configuration is enabled, and the subtype must be in that source's effective set. When that flag is off,sourceIdis ignored and the source is the subtype's own source. - Accepts
entitlements(comment, start date, and remove date) while per-entitlement request details are enabled.entitlementIdsis honored while that flag is off. A non-empty list of the other kind returns400. - Supports subtypes that are not tied to a single source while tiered subtype configuration is enabled. Version 1 rejects those subtypes.
There is no v2 status endpoint. Use the returned accountRequestId with Get Machine Account Creation Request to track the request.
This API returns 403 when machine identity creation is not included in the tenant's plan. When machine account creation is not enabled for the tenant, this API returns 404.
This API requires the sp:scopes:default scope.
NOTE: You can only request a machine account on a subtype for which you have a create machine account entitlement provisioned. Otherwise, this API returns
403.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| XSailPointExperimental | String | True (default to "true") | Use this header to enable this experimental API. | |
| Body | MachineAccountCreateRequestInputV2 | MachineAccountCreateRequestInputV2 | True |
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 202 | Machine account creation request result. | AccountRequestAsyncResult |
| 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. | CreateMachineAccountRequestV1401Response |
| 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. | CreateMachineAccountRequestV1429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$MachineAccountCreateRequestInputV2 = @"{
"sourceId" : "2c9180907c1e4b3a017c1e5f2a3b0001",
"formId" : "4f1bb61b-a0ab-4c0a-b9fb-20f44407b75a",
"entitlements" : [ {
"id" : "858d2151-ff19-464b-ae0d-6938b3af2baf",
"comment" : "Needed to read the reconciliation staging tables.",
"startDate" : "2026-09-01T00:00:00.000Z",
"removeDate" : "2027-03-01T00:00:00.000Z"
}, {
"id" : "0c7a44b9-3e21-4f88-9a10-77bd2c6e5f31"
} ],
"entitlementIds" : [ "858d2151-ff19-464b-ae0d-6938b3af2baf", "0c7a44b9-3e21-4f88-9a10-77bd2c6e5f31" ],
"environment" : "production",
"description" : "Nightly reconciliation job",
"machineIdentityId" : "b1e2c3d4-0a5b-4c6d-8e7f-9a0b1c2d3e4f",
"ownerIdentityId" : "9f2c1b7e4a6d4c8fa1b2c3d4e5f60718",
"userInput" : {
"accountName" : "svc-recon-01"
},
"subtypeId" : "1419fc28-a8ed-4a07-9f5c-0cb5dfad6311"
}"@
# Create Machine Account (v2)
try {
$Result = ConvertFrom-JsonToMachineAccountCreateRequestInputV2 -Json $MachineAccountCreateRequestInputV2
New-MachineAccountV2 -XSailPointExperimental $XSailPointExperimental -MachineAccountCreateRequestInputV2 $Result
# Below is a request that includes all optional parameters
# New-MachineAccountV2 -XSailPointExperimental $XSailPointExperimental -MachineAccountCreateRequestInputV2 $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-MachineAccountV2"
Write-Host $_.ErrorDetails
}
get-create-machine-account-request-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Retrieves a account request details for machine account creation. This allows the user to view all details for given account request.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| XSailPointExperimental | String | True (default to "true") | Use this header to enable this experimental API. | |
| Path | AccountRequestId | String | True | Account Request ID |
Return type
Responses
| Code | Description | Data Type |
|---|---|---|
| 200 | Account Request Details object | AccountRequestDetailsDto |
| 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. | CreateMachineAccountRequestV1401Response |
| 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. | CreateMachineAccountRequestV1429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccountRequestId = "gt38f94347e94562b5bb8424a56498d8" # String | Account Request ID
# Get Machine Account Creation Request
try {
Get-CreateMachineAccountRequestV1 -XSailPointExperimental $XSailPointExperimental -AccountRequestId $AccountRequestId
# Below is a request that includes all optional parameters
# Get-CreateMachineAccountRequestV1 -XSailPointExperimental $XSailPointExperimental -AccountRequestId $AccountRequestId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CreateMachineAccountRequestV1"
Write-Host $_.ErrorDetails
}
get-machine-account-create-access-info-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| XSailPointExperimental | String | True (default to "true") | Use this header to enable this experimental API. | |
| Query | Offset | Int64 | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in API Standard Collection Parameters. The offset value is record-based, not page-based, and the index starts at 0. |
| Query | Limit | Int64 | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in API Standard Collection Parameters. If it is not specified, a default limit is used. |
Return type
MachineAccountCreateAccessDto[]
Responses
| Code | Description | Data Type |
|---|---|---|
| 200 | List of source and the subtypes. | MachineAccountCreateAccessDto[] |
| 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. | CreateMachineAccountRequestV1401Response |
| 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. | CreateMachineAccountRequestV1429Response |
| 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
# Machine Account Create Access
try {
Get-MachineAccountCreateAccessInfoV1 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-MachineAccountCreateAccessInfoV1 -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MachineAccountCreateAccessInfoV1"
Write-Host $_.ErrorDetails
}