> This page is for Multi-Tenant, version v3.0 (default).
> For other versions, use one of these documentation indexes:
> - v3.0 (default): https://docs.nvidia.com/run-ai/multi-tenant/v3.0/llms.txt
> - v2.26: https://docs.nvidia.com/run-ai/multi-tenant/v2.26/llms.txt
> - v2.25: https://docs.nvidia.com/run-ai/multi-tenant/v2.25/llms.txt
> - v2.24: https://docs.nvidia.com/run-ai/multi-tenant/v2.24/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/run-ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/run-ai/_mcp/server.

# Get an access rule.

GET http://localhost:8080/api/v1/authorization/access-rules/{accessRuleId}

Use to retrieve the details of an access rule by id.

Reference: https://docs.nvidia.com/run-ai/multi-tenant/reference/rest-api/endpoints/authentication-and-authorization/access-rules/get-access-rule

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication

## Request

### Path parameters

- `accessRuleId` (integer, required) — The id of the access rule to retrieve

## Response

### 200

Executed successfully.

- `subjectId` (string, required) — The unique identifier of the subject (e.g., user, group, or app).
- `roleId` (integer, required) — The numeric ID of the assigned role.
- `scopeId` (string, required) — The unique identifier of the scope.
- `scopeType` (enum, required)
  - Allowed values: `system`, `tenant`, `cluster`, `department`, `project`
- `subjectType` (enum, required) — Subject type enum for access rule responses. Extends SubjectType with the built-in all-authenticated-users subject, which applies to every authenticated user and service account. Note: The 'app' subject type is DEPRECATED. Please use 'service-account' instead for service accounts.
  - Allowed values: `user`, `app`, `service-account`, `group`, `all-authenticated-users`
- `roleName` (string, required) — The name of the assigned role (e.g., admin, viewer).
- `scopeName` (string, required) — Human-readable name of the scope (e.g., tenant-x).
- `id` (integer, required) — The ID of the access rule entry.
- `createdAt` (datetime, required) — The timestamp for when the access rule was created.
- `updatedAt` (datetime, required) — The timestamp for the last time the access rule was updated.
- `tenantId` (integer, required) — The id of the tenant.
- `createdBy` (string, required) — Identifier of the user who created the access rule.
- `clusterId` (string, optional) — The id of the cluster.
- `deletedAt` (datetime, optional, nullable) — The timestamp indicating when the access rule was deleted.
- `status` (AccessRuleStatusResponse, optional) — Status of the Access Rule in the cluster. Available only for clusters of version 2.22.0 or above.
- `scopePath` (string, optional, nullable)

## Errors

### 401 Unauthorized Error

Unauthorized

- `code` (integer, required)
- `message` (string, required)
- `details` (string, optional)

### 403 Forbidden Error

Forbidden

- `code` (integer, required)
- `message` (string, required)
- `details` (string, optional)

### 404 Not Found Error

The specified resource was not found

- `code` (integer, required)
- `message` (string, required)
- `details` (string, optional)

### 500 Internal Server Error

unexpected error

- `code` (integer, required)
- `message` (string, required)
- `details` (string, optional)

### 503 Service Unavailable Error

unexpected error

- `code` (integer, required)
- `message` (string, required)
- `details` (string, optional)

## Types

### AccessRuleStatusResponse

Status of the Access Rule in the cluster. Available only for clusters of version 2.22.0 or above.

- `phase` (enum, optional) — Phase of the Access Rule in the cluster.
  - Allowed values: `Creating`, `Ready`, `NotReady`, `Deleting`
- `message` (string, optional) — Message for status of Access Rule in the cluster
- `details` (string, optional) — Details for status of Access Rule in the clusters

## Examples

**Response**

```json
{
  "subjectId": "user@run.ai",
  "roleId": 53142648,
  "scopeId": "a418ed33-9399-48c0-a890-122cadd13bfd",
  "scopeType": "system",
  "subjectType": "user",
  "roleName": "admin",
  "scopeName": "tenant-x",
  "id": 32,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "tenantId": 1001,
  "createdBy": "user@run.ai",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "deletedAt": "2024-01-15T09:30:00Z",
  "status": {
    "phase": "Ready",
    "message": "Failed to enforce department 'department-a'",
    "details": "NotReady: [cluster1-uuid]; Ready: [cluster2-uuid, cluster3-uuid]"
  },
  "scopePath": "runai/production-cluster/dep-42/prj-73"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:8080/api/v1/authorization/access-rules/32"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:8080/api/v1/authorization/access-rules/32';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/authorization/access-rules/32"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/authorization/access-rules/32")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/authorization/access-rules/32")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:8080/api/v1/authorization/access-rules/32', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/authorization/access-rules/32");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/authorization/access-rules/32")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```