MattW.95551 (Customer) asked a question.
I would like to add a new rule via API, with some actions, I know that doing this through the website gives a GUI interface for defining rules and their actions, however for doing this via the API I have not been able to find any documentation on the structure and options for constructing the actions object in a request.
Where can I find some documentation on constructing an actions object for this request.
Thanks
Thank you for posting on our Community page.
If you are talking about Group Rules then you can find documentation here: https://developer.okta.com/docs/reference/api/groups/#create-group-rule
You can scroll until you see a Request Example, in which is the actions object and it looks like this:
"actions": {
"assignUserToGroups": {
"groupIds": [
"00gjitX9HqABSoqTB0g3"
]
}
}
If you want to create a Policy Rule you can follow this documentation: https://developer.okta.com/docs/reference/api/policy/#create-a-rule
Here too there is a Request Example and the actions object looks like this:
"actions": {
"signon": {
"access": "ALLOW"
}
}
There is some more information on Actions Objects here: https://developer.okta.com/docs/reference/api/policy/#actions-objects
Thank you,
Marian Cambei
Technical Support Engineer | Okta
I understand how to create a rule for a group or policy, my problem is that I do not have any reference for what the capabilities of the "actions" object are. I can intuit what the 2 examples you gave mean, but I don't know what other settings the actions object can modify, etc.
https://developer.okta.com/docs/reference/api/policy/#actions-objects does not explain the options for constructing an "actions" object either.
The actions object is different for each API request.
There is not a list of all parameter for the actions object, but you can search for the API request that you want to use and see the actions object parameters there for that particular request.
If you need assistance regarding this issues, you can always open a case.
Thank you,
Marian Cambei
Technical Support Engineer | Okta
We use cookies to provide the best website experience and to help understand marketing efforts. We may also share data with ad partners to reach potential customers across the web. To learn more, visit our Privacy Policy. Click here for Your Privacy Choices. You may also opt out of this sharing by signaling your preference via GPC, applicable only to the browser signaling the opt-out.
More information
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising.
Select All
We use cookies to provide the best website experience and to help understand marketing efforts. We may also share data with ad partners to reach potential customers across the web. To learn more, visit our Privacy Policy. Click here for Your Privacy Choices. You may also opt out of this sharing by signaling your preference via GPC, applicable only to the browser signaling the opt-out.
More information
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising.
Select All
Thank you for posting on our Community page.
If you are talking about Group Rules then you can find documentation here: https://developer.okta.com/docs/reference/api/groups/#create-group-rule
You can scroll until you see a Request Example, in which is the actions object and it looks like this:
"actions": {
"assignUserToGroups": {
"groupIds": [
"00gjitX9HqABSoqTB0g3"
]
}
}
If you want to create a Policy Rule you can follow this documentation: https://developer.okta.com/docs/reference/api/policy/#create-a-rule
Here too there is a Request Example and the actions object looks like this:
"actions": {
"signon": {
"access": "ALLOW"
}
}
There is some more information on Actions Objects here: https://developer.okta.com/docs/reference/api/policy/#actions-objects
Thank you,
Marian Cambei
Technical Support Engineer | Okta