Realm Assignments

The Realm Assignments API provides operations to manage Realm Assignments

List all Realm Assignments
Early Access
OAuth 2.0: okta.realmAssignments.read

Lists all Realm Assignments

Request
query Parameters
limit
integer [ 1 .. 200 ]
Default: 20

A limit on the number of objects to return

after
string

The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination.

Responses
200

OK

403

Forbidden

429

Too Many Requests

get/api/v1/realm-assignments
Request samples
Response samples
application/json
[
  • {
    • "id": "rul2jy7jLUlnO3ng00g4",
    • "status": "ACTIVE",
    • "name": "Realm Assignment 1",
    • "created": "2022-04-04T15:56:05.000Z",
    • "lastUpdated": "2022-05-05T18:15:44.000Z",
    • "isDefault": false,
    • "conditions": {
      },
    • "actions": {
      },
    • "priority": 0,
    • "_links": {}
    },
  • {
    • "id": "rul2jy7jLUlnO5ng00g4",
    • "status": "ACTIVE",
    • "name": "Catch-all",
    • "created": "2022-04-04T15:56:05.000Z",
    • "lastUpdated": "2022-05-05T18:15:44.000Z",
    • "isDefault": true,
    • "conditions": {
      },
    • "actions": {
      },
    • "priority": 499,
    • "_links": {}
    }
]

Create a Realm Assignment
Early Access
OAuth 2.0: okta.realmAssignments.manage

Creates a new Realm Assignment

Request
Request Body schema: application/json
required
object (Actions)
object (AssignUserToRealm)
realmId
string
object (Conditions)
object (Expression)
value
string
profileSourceId
string
name
string
priority
integer
Responses
201

Created

400

Bad Request

403

Forbidden

429

Too Many Requests

post/api/v1/realm-assignments
Request samples
application/json
{
  • "actions": {
    • "assignUserToRealm": {
      }
    },
  • "conditions": {
    • "expression": {
      },
    • "profileSourceId": "string"
    },
  • "name": "string",
  • "priority": 0
}
Response samples
application/json
{
  • "actions": {
    • "assignUserToRealm": {
      }
    },
  • "conditions": {
    • "expression": {
      },
    • "profileSourceId": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "isDefault": true,
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "priority": 0,
  • "status": "ACTIVE",
  • "_links": {
    • "self": {
      }
    }
}

List all Realm Assignment operations
Early Access
OAuth 2.0: okta.realmAssignments.read

Lists all Realm Assignment operations. The upper limit is 200 and operations are sorted in descending order from most recent to oldest by id

Request
query Parameters
limit
integer [ 1 .. 200 ]
Default: 20

A limit on the number of objects to return

after
string

The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination.

Responses
200

OK

403

Forbidden

429

Too Many Requests

get/api/v1/realm-assignments/operations
Request samples
Response samples
application/json
[
  • {
    • "id": "rre4mje4ez6B2a7B60g7",
    • "type": "realm:assignment",
    • "status": "COMPLETED",
    • "created": "2023-10-25T21:02:54.000Z",
    • "started": "2023-10-25T21:02:54.000Z",
    • "completed": "2023-10-25T21:02:54.000Z",
    • "realmId": "00g1b7rvh0xPLKXFf0g5",
    • "realmName": "Realm Name",
    • "assignmentOperation": {
      },
    • "numUserMoved": 50,
    • "_links": {}
    },
  • {
    • "id": "rre4mje4ez7B2a7B60g7",
    • "type": "realm:assignment",
    • "status": "COMPLETED",
    • "created": "2023-10-25T21:02:54.000Z",
    • "started": "2023-10-25T21:02:54.000Z",
    • "completed": "2023-10-25T21:02:54.000Z",
    • "assignmentOperation": {
      },
    • "numUserMoved": 50,
    • "_links": {}
    }
]

Execute a Realm Assignment
Early Access
OAuth 2.0: okta.realmAssignments.manage

Executes a Realm Assignment

Request
Request Body schema: application/json
required
assignmentId
string
Responses
201

Created

400

Bad Request

403

Forbidden

429

Too Many Requests

post/api/v1/realm-assignments/operations
Request samples
application/json
{
  • "assignmentId": "0pr1b7rxZj2ibQzfP0g5"
}
Response samples
application/json
{
  • "id": "rre4mje4ez6B2a7B60g7",
  • "type": "realm:assignment",
  • "status": "COMPLETED",
  • "created": "2023-10-25T21:02:54.000Z",
  • "started": "2023-10-25T21:02:54.000Z",
  • "completed": "2023-10-25T21:02:54.000Z",
  • "realmId": "00g1b7rvh0xPLKXFf0g5",
  • "realmName": "Realm Name",
  • "assignmentOperation": {
    • "configuration": {
      }
    },
  • "numUserMoved": 50,
  • "_links": {}
}

Retrieve a Realm Assignment
Early Access
OAuth 2.0: okta.realmAssignments.read

Retrieves a Realm Assignment

Request
path Parameters
assignmentId
required
string

id of the Realm Assignment

Example: rul2jy7jLUlnO3ng00g4
Responses
200

Success

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/realm-assignments/{assignmentId}
Request samples
Response samples
application/json
{
  • "id": "rul2jy7jLUlnO3ng00g4",
  • "status": "ACTIVE",
  • "name": "Realm Assignment 1",
  • "created": "2022-04-04T15:56:05.000Z",
  • "lastUpdated": "2022-05-05T18:15:44.000Z",
  • "isDefault": false,
  • "conditions": {
    • "profileSourceId": "0oa4enoRyjwSCy5hx0g4",
    • "expression": {
      }
    },
  • "actions": {
    • "assignUserToRealm": {
      }
    },
  • "priority": 0,
  • "_links": {}
}

Replace a Realm Assignment
Early Access
OAuth 2.0: okta.realmAssignments.manage

Replaces a Realm Assignment

Request
path Parameters
assignmentId
required
string

id of the Realm Assignment

Example: rul2jy7jLUlnO3ng00g4
Request Body schema: application/json
required
object (Actions)
object (AssignUserToRealm)
realmId
string
object (Conditions)
object (Expression)
value
string
profileSourceId
string
name
string
priority
integer
Responses
200

Success

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

put/api/v1/realm-assignments/{assignmentId}
Request samples
application/json
{
  • "actions": {
    • "assignUserToRealm": {
      }
    },
  • "conditions": {
    • "expression": {
      },
    • "profileSourceId": "string"
    },
  • "name": "string",
  • "priority": 0
}
Response samples
application/json
{
  • "actions": {
    • "assignUserToRealm": {
      }
    },
  • "conditions": {
    • "expression": {
      },
    • "profileSourceId": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "isDefault": true,
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "priority": 0,
  • "status": "ACTIVE",
  • "_links": {
    • "self": {
      }
    }
}

Delete a Realm Assignment
Early Access
OAuth 2.0: okta.realmAssignments.manage

Deletes a Realm Assignment

Request
path Parameters
assignmentId
required
string

id of the Realm Assignment

Example: rul2jy7jLUlnO3ng00g4
Responses
204

No Content

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

delete/api/v1/realm-assignments/{assignmentId}
Request samples
Response samples
application/json
{
  • "errorCauses": [
    • {
      }
    ],
  • "errorCode": "string",
  • "errorId": "string",
  • "errorLink": "string",
  • "errorSummary": "string"
}

Activate a Realm Assignment
Early Access
OAuth 2.0: okta.realmAssignments.manage

Activates a Realm Assignment

Request
path Parameters
assignmentId
required
string

id of the Realm Assignment

Example: rul2jy7jLUlnO3ng00g4
Responses
204

No Content

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/realm-assignments/{assignmentId}/lifecycle/activate
Request samples
Response samples
application/json
{
  • "errorCode": "E0000001",
  • "errorSummary": "Api validation failed: {0}",
  • "errorLink": "E0000001",
  • "errorId": "sampleiCF-8D5rLW6myqiPItW",
  • "errorCauses": [ ]
}

Deactivate a Realm Assignment
Early Access
OAuth 2.0: okta.realmAssignments.manage

Deactivates a Realm Assignment

Request
path Parameters
assignmentId
required
string

id of the Realm Assignment

Example: rul2jy7jLUlnO3ng00g4
Responses
204

No Content

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/realm-assignments/{assignmentId}/lifecycle/deactivate
Request samples
Response samples
application/json
{
  • "errorCode": "E0000001",
  • "errorSummary": "Api validation failed: {0}",
  • "errorLink": "E0000001",
  • "errorId": "sampleiCF-8D5rLW6myqiPItW",
  • "errorCauses": [ ]
}