Identity Sources

The Okta Identity Source API provides a mechanism to synchronize an HR source (the custom identity source) with Okta user profiles in an org.

List all Identity Source Sessions
OAuth 2.0: okta.identitySources.read

Lists all identity source sessions for the given identity source instance

Request
path Parameters
identitySourceId
required
string
Responses
200

Success

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/identity-sources/{identitySourceId}/sessions
Request samples 
Response samples 
application/json
[
  • {
    • "id": "uij4ri8ZLk0ywyqxB0g1",
    • "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
    • "status": "CREATED",
    • "importType": "INCREMENTAL",
    • "created": "2022-04-04T15:56:05.000Z",
    • "lastUpdated": "2022-05-05T16:15:44.000Z"
    },
  • {
    • "id": "uij4ri8ZLk0ywyqxB0g2",
    • "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
    • "status": "TRIGGERED",
    • "importType": "INCREMENTAL",
    • "created": "2022-04-04T16:56:05.000Z",
    • "lastUpdated": "2022-05-05T17:15:44.000Z"
    },
  • {
    • "id": "uij4ri8ZLk0ywyqxB0g3",
    • "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
    • "status": "IN_PROGRESS",
    • "importType": "INCREMENTAL",
    • "created": "2022-04-04T17:56:05.000Z",
    • "lastUpdated": "2022-05-05T18:15:44.000Z"
    },
  • {
    • "id": "uij4ri8ZLk0ywyqxB0g4",
    • "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
    • "status": "EXPIRED",
    • "importType": "INCREMENTAL",
    • "created": "2022-04-04T18:56:05.000Z",
    • "lastUpdated": "2022-05-05T19:15:44.000Z"
    },
  • {
    • "id": "uij4ri8ZLk0ywyqxB0g5",
    • "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
    • "status": "CLOSED",
    • "importType": "INCREMENTAL",
    • "created": "2022-04-04T19:56:05.000Z",
    • "lastUpdated": "2022-05-05T20:15:44.000Z"
    }
]
Create an Identity Source Session
OAuth 2.0: okta.identitySources.manage
Creates an identity source session for the given identity source instance


Request 
path Parameters
identitySourceId
required
string
 
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/identity-sources/{identitySourceId}/sessions
Request samples 
Response samples 
application/json
[
  • {
    • "id": "uij4ri8ZLk0ywyqxB0g1",
    • "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
    • "status": "CREATED",
    • "importType": "INCREMENTAL",
    • "created": "2022-04-04T15:56:05.000Z",
    • "lastUpdated": "2022-05-05T16:15:44.000Z"
    }
]
Retrieve an Identity Source Session
OAuth 2.0: okta.identitySources.read
Retrieves an identity source session for a given identity source id and session id


Request 
path Parameters
identitySourceId
required
string
 
sessionId
required
string
 
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}
Request samples 
Response samples 
application/json
[
  • {
    • "id": "uij4ri8ZLk0ywyqxB0g1",
    • "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
    • "status": "CREATED",
    • "importType": "INCREMENTAL",
    • "created": "2022-04-04T15:56:05.000Z",
    • "lastUpdated": "2022-05-05T16:15:44.000Z"
    }
]
Delete an Identity Source Session
OAuth 2.0: okta.identitySources.manage
Deletes an identity source session for a given identitySourceId and sessionId


Request 
path Parameters
identitySourceId
required
string
 
sessionId
required
string
 
Responses 
204
No Content


403
Forbidden


404
Not Found


429
Too Many Requests


delete/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}
Upload the data to be deleted in Okta
OAuth 2.0: okta.identitySources.manage
Uploads entities that need to be deleted in Okta from the identity source for the given session


Request 
path Parameters
identitySourceId
required
string
 
sessionId
required
string
 
Request Body schema: application/json
entityType
string
 Value: "USERS"  
Array of objects (IdentitySourceUserProfileForDelete) 
 
 Array 
externalId
string  <= 512 characters 
 
Responses 
202
Accepted


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-delete
Request samples 
application/json
{
  • "entityType": "USERS",
  • "profiles": [
    • {
      }
    ]
}
Response samples 
application/json
{
  • "errorCode": "E0000001",
  • "errorSummary": "Api validation failed: {0}",
  • "errorLink": "E0000001",
  • "errorId": "sampleiCF-8D5rLW6myqiPItW",
  • "errorCauses": [ ]
}
Upload the data to be upserted in Okta
OAuth 2.0: okta.identitySources.manage
Uploads entities that need to be upserted in Okta from the identity source for the given session


Request 
path Parameters
identitySourceId
required
string
 
sessionId
required
string
 
Request Body schema: application/json
entityType
string
 Value: "USERS"  
Array of objects (IdentitySourceUserProfileForUpsert) 
 
 Array 
email
string <email>   [ 5 .. 100 ] characters 
 
firstName
string or null  [ 1 .. 50 ] characters 
 
homeAddress
string or null  <= 4096 characters 
 
lastName
string or null  [ 1 .. 50 ] characters 
 
mobilePhone
string or null  <= 100 characters 
 
secondEmail
string <email>   [ 5 .. 100 ] characters 
 
userName
string  <= 100 characters 
 
property name*
additional property
any
 
Responses 
202
Accepted


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-upsert
Request samples 
application/json
{
  • "entityType": "USERS",
  • "profiles": [
    • {
      }
    ]
}
Response samples 
application/json
{
  • "errorCode": "E0000001",
  • "errorSummary": "Api validation failed: {0}",
  • "errorLink": "E0000001",
  • "errorId": "sampleiCF-8D5rLW6myqiPItW",
  • "errorCauses": [ ]
}
Start the import from the Identity Source
OAuth 2.0: okta.identitySources.manage
Starts the import from the identity source described by the uploaded bulk operations


Request 
path Parameters
identitySourceId
required
string
 
sessionId
required
string
 
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/start-import
Request samples 
Response samples 
application/json
[
  • {
    • "id": "uij4ri8ZLk0ywyqxB0g4",
    • "identitySourceId": "0oa3l6l6WK6h0R0QW0g4",
    • "status": "TRIGGERED",
    • "importType": "INCREMENTAL",
    • "created": "2022-04-04T15:56:05.000Z",
    • "lastUpdated": "2022-05-05T18:15:44.000Z"
    }
]