Oracle Linux Automation Manager CLI and API Reference Guide

Retrieve a Role

get

/api/v2/roles/{id}/

Make GET request to this resource to retrieve a single role record containing the following fields:

id: Database ID for this role. (integer)
type: Data type for this role. (choice)
url: URL for this role. (string)
related: Data structure with URLs of related resources. (object)
summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
name: Name of this role. (field)
description: Optional description of this role. (field)

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Response

Supported Media Types

application/json

200 Response

Root Schema : Role

Type: object

Show Source

description: string

Title: Description

Read Only: true
id: integer

Title: ID

Read Only: true
name: string

Title: Name

Read Only: true
related: string

Title: Related

Read Only: true
summary_fields: string

Title: Summary fields

Read Only: true
type: string

Title: Type

Read Only: true
url: string

Title: Url

Read Only: true

{
    "properties":{
        "description":{
            "readOnly":true,
            "title":"Description",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "name":{
            "readOnly":true,
            "title":"Name",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "type":"object"
}