The Okta Identity Source API provides a mechanism to synchronize an HR source (the custom identity source) with Okta user profiles in an org.
okta.identitySources.read
Lists all Identity Source Sessions for the given Identity Source instance
Success
Forbidden
Not Found
Too Many Requests
[- {
- "id": "aps1qqonvr2SZv6o70h8",
- "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
- "status": "CREATED",
- "importType": "INCREMENTAL",
- "created": "2022-04-04T15:56:05.000Z",
- "lastUpdated": "2022-05-05T16:15:44.000Z"
}, - {
- "id": "aps1quck606ngubVq0h8",
- "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
- "status": "TRIGGERED",
- "importType": "INCREMENTAL",
- "created": "2022-04-04T16:56:05.000Z",
- "lastUpdated": "2022-05-05T17:15:44.000Z"
}, - {
- "id": "aps1qzy2acb5jDlUc0h8",
- "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
- "status": "IN_PROGRESS",
- "importType": "INCREMENTAL",
- "created": "2022-04-04T17:56:05.000Z",
- "lastUpdated": "2022-05-05T18:15:44.000Z"
}, - {
- "id": "aps1qqne8c1JHkMdF0h8",
- "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
- "status": "EXPIRED",
- "importType": "INCREMENTAL",
- "created": "2022-04-04T18:56:05.000Z",
- "lastUpdated": "2022-05-05T19:15:44.000Z"
}, - {
- "id": "aps1qqonvr2SZv6o70h8",
- "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
- "status": "CLOSED",
- "importType": "INCREMENTAL",
- "created": "2022-04-04T19:56:05.000Z",
- "lastUpdated": "2022-05-05T20:15:44.000Z"
}
]
okta.identitySources.manage
Creates an Identity Source Session for the given Identity Source instance
Success
Forbidden
Not Found
Too Many Requests
{- "id": "aps1qqonvr2SZv6o70h8",
- "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
- "status": "CREATED",
- "importType": "INCREMENTAL",
- "created": "2022-04-04T15:56:05.000Z",
- "lastUpdated": "2022-05-05T16:15:44.000Z"
}
okta.identitySources.read
Retrieves an Identity Source Session for a given Identity Source ID and session ID
Success
Forbidden
Not Found
Too Many Requests
{- "id": "aps1qqonvr2SZv6o70h8",
- "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
- "status": "CREATED",
- "importType": "INCREMENTAL",
- "created": "2022-04-04T15:56:05.000Z",
- "lastUpdated": "2022-05-05T16:15:44.000Z"
}
okta.identitySources.manage
Deletes an Identity Source Session for a given identitySourceId
and sessionId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.identitySources.manage
Uploads external IDs of entities that need to be deleted in Okta from the Identity Source for the given session
Accepted
Bad Request
Forbidden
Not Found
Too Many Requests
{- "entityType": "USERS",
- "profiles": [
- {
- "externalId": "EXT123456784C2IF"
}, - {
- "externalId": "EXT123456784C3IF"
}, - {
- "externalId": "EXT123456784C4IF"
}
]
}
{- "errorCode": "E0000001",
- "errorSummary": "Api validation failed: {0}",
- "errorLink": "E0000001",
- "errorId": "sampleiCF-8D5rLW6myqiPItW",
- "errorCauses": [ ]
}
okta.identitySources.manage
Uploads entities that need to be inserted or updated in Okta from the Identity Source for the given session
Accepted
Bad Request
Forbidden
Not Found
Too Many Requests
{- "entityType": "USERS",
- "profiles": [
- {
- "externalId": "EXT123456784C2IF",
- "profile": {
- "userName": "isaac.brock@example.com",
- "firstName": "Isaac",
- "lastName": "Brock",
- "email": "isaac.brock@example.com",
- "secondEmail": "isaac2.brock@example.com",
- "mobilePhone": "123-456-7890",
- "homeAddress": "Kirkland, WA"
}
}
]
}
{- "errorCode": "E0000001",
- "errorSummary": "Api validation failed: {0}",
- "errorLink": "E0000001",
- "errorId": "sampleiCF-8D5rLW6myqiPItW",
- "errorCauses": [ ]
}
okta.identitySources.manage
Starts the import from the Identity Source described by the uploaded bulk operations
Success
Forbidden
Not Found
Too Many Requests
[- {
- "id": "aps1qqonvr2SZv6o70h8",
- "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
- "status": "TRIGGERED",
- "importType": "INCREMENTAL",
- "created": "2022-04-04T15:56:05.000Z",
- "lastUpdated": "2022-05-05T18:15:44.000Z"
}
]