My Settings

The My Settings API allows end users to manage their governance settings. The response is specifically for the authenticated user (the end user) making the request. Use this API to view and manage settings, such as appointing a delegate for governance reviews.

Retrieve the settings
Beta
OAuth 2.0 scopes:
  • okta.governance.settings.read

Retrieves the settings for the current user

Responses
200

A successful my settings response

401

When authentication fails

403

When authorization fails

404

When the requested resource wasn't found

429

When the rate limit has been exceeded

500

When there is a server fault due to an unexpected error

get/governance/api/v1/my/settings
Request samples 
Response samples 
application/json
{
  • "delegates": {
    • "appointments": [
      • {
        }
      ]
    }
}
Update the settings
Beta
OAuth 2.0 scopes: 
  • okta.governance.settings.manage
Updates the settings for the current user


Request 
Request Body schema: application/json
required
object
Delegates for the principal


 
Responses 
200
A successful my settings response


400
When governance settings fails as bad request


401
When authentication fails


403
When authorization fails


429
When the rate limit has been exceeded


500
When there is a server fault due to an unexpected error


patch/governance/api/v1/my/settings
Request samples 
application/json
{
  • "delegates": {
    • "appointments": [
      • {
        }
      ]
    }
}
Response samples 
application/json
{
  • "delegates": {
    • "appointments": [
      • {
        }
      ]
    }
}
List the eligible delegate users
Beta
OAuth 2.0 scopes: 
  • okta.governance.settings.read
Lists the users who match the filtered query and are eligible delegates for the current user.


Request examples with query parameters:


    

  1. Filter users with a last name that starts with "Smi"
    /governance/api/v1/my/settings/delegates/users?filter=lastName%20sw%20%22Smi%22

    

    2. 

  2. Filter for users with a first name that begins with "John"
    /governance/api/v1/my/settings/delegates/users?filter=firstName%20sw%20%22John%22

    

    3. 

  3. Search for users with a first or last name that begins with "John"
    /governance/api/v1/my/settings/delegates/users?filter=firstName%20sw%20%22John%22%20OR%20lastName%20sw%20%22John%22

    

    4. 



Request 
query Parameters
after
string
The pagination cursor that points to the last record of the previous request.


 
 Example:  after=00u68w6vzKLultXS97g6
filter
required
string <scim-filter> 
A required filter expression that returns users based on the firstName or lastName properties.
This filter expression supports the sw operator.


Note: Query parameter percent encoding is required. See Special characters.


 
 Example:  filter=firstName sw "John" OR lastName sw "John"
limit
integer  [ 1 .. 200 ] 
 Default:  20
The maximum number of records returned in a response


 
Responses 
200
Lists my eligible delegate users


400
An invalid list request


401
When authentication fails


403
When authorization fails


429
When the rate limit has been exceeded


500
When there is a server fault due to an unexpected error


get/governance/api/v1/my/settings/delegate/users
Request samples 
Response samples 
application/json
Lists all users who are eligible delegates for the authenticated user


{
  • "data": [
    • {
      • "id": "00u28w6vzKKultXP98g5",
      • "email": "jessie.smith@example.com",
      • "firstName": "Jessie",
      • "lastName": "Smith"
      },
    • {
      • "id": "00u28w6vzKKultXP97g5",
      • "email": "jacky.chen@example.com",
      • "firstName": "Jacky",
      • "lastName": "Chen"
      },
    • {
      • "id": "00u28w6vzKKultXP97g6",
      • "email": "tal.gupta@example.com",
      • "firstName": "Tal",
      • "lastName": "Gupta"
      },
    • {
      • "id": "00u28w6vzKKultXP97g6",
      • "email": "chad.Beauchamp-Williams-Wrightman-Smithson@example.com",
      • "firstName": "Chad",
      • "lastName": "Beauchamp-Williams-Wrightman-Smithson"
      },
    • {
      • "id": "00u28w8vzKLultXP97g6",
      • "email": "Lorena.FernándezDeCórdoba@example.com",
      • "firstName": "Lorena",
      • "lastName": "Fernández de Córdoba"
      },
    • {
      • "id": "00u68w6vzKLultXS97g6",
      • "email": "SeraphinianaAlessandrovich.Raskolnikov-Karamazov-Smirnovich@example.com",
      • "firstName": "SeraphinianaAlessandrovich",
      • "lastName": "Raskolnikov-Karamazov-Smirnovich"
      }
    ],
  • "_links": {}
}