Optimizely Admin User Profiles API
The Admin User Profiles API from Optimizely — 12 operation(s) for admin user profiles.
Operations 19
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/api/v1/admin/AdminUserProfiles
List admin console user profiles · Returns the EntitySet AdminUserProfiles
#
Ask an LLM
“How do I list every admin user who can sign in to the Optimizely Commerce admin console?”
“Can I filter admin user profiles to just the deactivated ones?”
Tell an agent
List all admin user profiles.
List admin user profiles matching the filter {filter}, sorted by {orderby}.
POST
/api/v1/admin/AdminUserProfiles
Create an admin console user · Post a new entity to EntitySet AdminUserProfiles
#
Ask an LLM
“How do I add a new administrator to the commerce admin console?”
“What details are required when creating an admin user profile?”
Tell an agent
Create an admin user {userName} for {firstName} {lastName} with email {email}.
Add a new admin console user {userName} whose console language is {defaultAdminConsoleLanguageCode}.
GET
/api/v1/admin/AdminUserProfiles({id})
Get one admin user profile · Returns the entity with the key from AdminUserProfiles
#
Ask an LLM
“How do I look up a single admin user's profile by its ID?”
“Can I see when a specific admin last logged in and whether they are deactivated?”
Tell an agent
Get admin user profile {id}.
Show the login and activation details for admin user {id}.
PUT
/api/v1/admin/AdminUserProfiles({id})
Replace an admin user profile · Replace entity in EntitySet AdminUserProfiles
#
Ask an LLM
“How do I overwrite an entire admin user profile with a new record?”
“Is there a way to fully replace an admin user's details rather than patch a few fields?”
Tell an agent
Replace admin user profile {id} with a full record for email {email}.
Overwrite the whole profile of admin user {id}, setting position to {position}.
DELETE
/api/v1/admin/AdminUserProfiles({id})
Delete an admin user profile · Delete entity in EntitySet AdminUserProfiles
#
Ask an LLM
“How do I permanently remove one admin user from the admin console?”
“Can I delete an admin profile only if it hasn't changed since I read it?”
Tell an agent destructive · confirm first
Delete admin user profile {id}.
Remove admin user {id} only if its ETag still matches {etag}.
PATCH
/api/v1/admin/AdminUserProfiles({id})
Update fields on an admin user profile · Update entity in EntitySet AdminUserProfiles
#
Ask an LLM
“How do I change an admin user's phone number or email without resending everything?”
“Can I deactivate an admin user by updating their profile?”
Tell an agent
Update the email of admin user {id} to {email}.
Set isDeactivated to {isDeactivated} on admin user {id}.
GET
/api/v1/admin/AdminUserProfiles/Default.Default()
Get a blank admin user profile template · Call operation Default
#
Ask an LLM
“What default values does a new admin user profile start with?”
“Can I fetch an empty admin user template before creating one?”
Tell an agent
Fetch the default admin user profile template.
Show me the starting values for a new admin user.
GET
/api/v1/admin/AdminUserProfiles({id})/Default.Roles()
Call the Roles function for an admin user · Call operation Roles
#
Ask an LLM
“How do I call the OData Roles function to see which roles an admin user holds?”
“Can I filter the result of the Roles function for one admin profile?”
Tell an agent
Call the Roles function for admin user profile {id}.
Run the Default.Roles() operation on admin user {id} filtered by {filter}.
GET
/api/v1/admin/AdminUserProfiles/Default.Current()
Get the signed-in admin via the Current function · Call operation Current
#
Ask an LLM
“How do I find out which admin profile my API token belongs to using the Current function?”
“Can I call Default.Current() to get my own admin user record?”
Tell an agent
Call the Default.Current() function to get my admin profile.
Using the OData Current function, return only the fields {select} of my admin profile.
GET
/api/v1/admin/adminuserprofiles/current
Get the signed-in admin's own profile · Admin user profiles current 2
#
Ask an LLM
“Who am I logged in as in the admin console, via the adminuserprofiles/current route?”
“Can I expand related data on my own admin profile from the current-user route?”
Tell an agent
Get my own admin profile from the adminuserprofiles/current route.
Fetch the current admin user and expand {expand}.
GET
/api/v1/admin/adminuserprofiles({key})/roles
List roles assigned to an admin user · Admin user profiles get roles by key
#
Ask an LLM
“Which roles are assigned to a given admin user through the roles route?”
“Can I page through an admin user's roles with top and skip?”
Tell an agent
List the roles assigned to admin user {key}.
Show the first {top} roles on admin user {key}.
PUT
/api/v1/admin/adminuserprofiles({key})/roles
Replace an admin user's roles (PUT) · Admin user profiles set roles by key 1
#
Ask an LLM
“How do I replace the full set of roles on an admin user with a PUT?”
“Can I overwrite an admin user's role assignments in one request?”
Tell an agent
Replace the roles on admin user {key} using PUT.
Overwrite every role assignment for admin {key} with PUT.
POST
/api/v1/admin/adminuserprofiles({key})/roles
Assign roles to an admin user (POST) · Admin user profiles set roles by key 2
#
Ask an LLM
“How do I post new role assignments to an admin user?”
“Can I grant roles to an admin through a POST to their roles route?”
Tell an agent
Assign roles to admin user {key} with a POST.
POST role assignments for admin {key}.
DELETE
/api/v1/admin/adminuserprofiles({key})/roles
Remove roles from an admin user · Admin user profiles delete roles by key
#
Ask an LLM
“How do I strip the roles from an admin user?”
“Can I revoke an admin user's role assignments without deleting the user?”
Tell an agent destructive · confirm first
Remove the roles from admin user {key}.
Revoke all role assignments for admin {key}, keeping the profile.
DELETE
/api/v1/admin/adminuserprofiles/delete
Bulk delete admin user profiles · Admin user profiles delete route
#
Ask an LLM
“How do I delete several admin users at once?”
“Can I remove a batch of admin profiles by passing a list of IDs?”
Tell an agent destructive · confirm first
Bulk delete the admin user profiles with IDs {ids}.
Remove these admin users in one call: {ids}.
GET
/api/v1/admin/adminuserprofiles({key})/adminuserprofilepasswords({adminuserprofilepasswordKey})
Get a password record for an admin user · Admin user profiles get admin user profile password by key and…
#
Ask an LLM
“How do I read one password history record stored for an admin user?”
“Can I see a specific admin user password entry by its key?”
Tell an agent
Get password record {adminuserprofilepasswordKey} for admin user {key}.
Show admin {key}'s password entry {adminuserprofilepasswordKey}.
GET
/api/v1/admin/adminuserprofiles({key})/adminuserprofilepreferences({adminuserprofilepreferenceKey})
Get a preference setting for an admin user · Admin user profiles get admin user profile preference by key and…
#
Ask an LLM
“How do I read one saved console preference for an admin user?”
“Can I fetch a single admin user preference by its key?”
Tell an agent
Get preference {adminuserprofilepreferenceKey} for admin user {key}.
Show admin {key}'s console preference {adminuserprofilepreferenceKey}.
GET
/api/v1/admin/adminuserprofiles({key})/customproperties({custompropertyKey})
Get a custom property on an admin user · Admin user profiles get custom property by key and custompropertykey
#
Ask an LLM
“How do I read a custom property stored on an admin user profile?”
“Can I fetch one extra property value from an admin user record?”
Tell an agent
Get custom property {custompropertyKey} on admin user {key}.
Show the custom property {custompropertyKey} of admin profile {key}.
GET
/api/v1/admin/adminuserprofiles({key})/websites({websiteKey})
Get a website an admin user can manage · Admin user profiles get website by key and websitekey
#
Ask an LLM
“How do I check whether an admin user is linked to a particular website?”
“Can I read one website assignment for an admin profile?”
Tell an agent
Get website {websiteKey} assigned to admin user {key}.
Show the website {websiteKey} linked to admin profile {key}.