Skip to content

Commit 0a755cf

Browse files
Merge pull request #769 from jasonnovichRunAI/RUN-17809-Developer-pages-corrections
RUN-17809-Developer-pages-corrections
2 parents 19c3997 + 6525dec commit 0a755cf

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

docs/admin/runai-setup/access-control/rbac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ To create a new access rule:
104104
2. **SSO Group**—a known group listed in your IDP server.
105105
!!! Note
106106
To add SSO users and groups, you must enter a user id, or group id that is recognized by the configured IDP.
107-
4. **Application**—an application that has been created in the platform.
107+
3. **Application**—an application that has been created in the platform.
108108

109109
4. Select a [Role] from the dropdown.
110110
5. Press the ![Scope](../../../images/scope-icon.svg) icon and select a scope, and press *SAVE RULE* when done.

docs/developer/admin-rest-api/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Administrator REST API
1+
# Control Plane REST API
22

33
The purpose of the Administrator REST API is to provide an easy-to-use programming interface for administrative tasks.
44

docs/developer/rest-auth.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,13 @@ Run:ai APIs are accessed using *bearer tokens*. A token can be obtained in sever
1515
* Go to `Settings & Tools`, `Application` and create a new Application.
1616
* Copy the `<APPLICATION>` and `<SECRET KEY>` to be used below
1717

18+
1819
### Access rules for the Application
1920

20-
* Set the required roles:
21-
* Select `Researcher` to manipulate *Jobs* using the [Cluster API](cluster-api/submit-rest.md). To provide access to a specific project, you will also need to go to `Application | Projects` and provide the Application with access to specific projects.
22-
* Select `Editor` to manipulate *Projects* and *Departments* using the [Administrator REST API](admin-rest-api/overview.md).
23-
* Select `Administrator` to manipulate *Users*, *Tenant Settings* and *Clusters* using the [Administrator REST API](admin-rest-api/overview.md).
21+
In order for you API requests to be accepted, you will need to set access rules for the application.
22+
To assign roles to an application, see [Create or Delete rules](../admin/runai-setup/access-control/rbac.md#create-or-delete-rules).
23+
24+
Use the [Roles](../admin/runai-setup/access-control/rbac.md#roles) table to assign the correct roles to the application.
2425

2526
## Request an API Token
2627

@@ -30,7 +31,8 @@ Use the above parameters to get a temporary token to access Run:ai as follows.
3031

3132
Replace `<COMPANY-URL>` below with:
3233

33-
* For SaaS installations use `<company>.run.ai`
34+
* For SaaS installations use `<company>.run.ai`
35+
3436
* For self-hosted use the Run:ai user interface URL.
3537

3638
=== "cURL"

0 commit comments

Comments
 (0)