Oracle Linux Automation Manager CLI and API Reference Guide

Retrieve Information About the Current User

get

/api/v2/me/

Make a GET request to retrieve user information about the current user.

One result should be returned containing the following fields:

id: Database ID for this user. (integer)
type: Data type for this user. (choice)
url: URL for this user. (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)
created: Timestamp when this user was created. (datetime)
modified: Timestamp when this user was last modified. (datetime)
username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string)
first_name: (string)
last_name: (string)
email: (string)
is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean)
is_system_auditor: (boolean)
password: Field used to change the password. (string)
ldap_dn: (string)
last_login: (datetime)
external_account: Set if the account is managed by an external service (field)

Use the primary URL for the user (/api/v2/users/N/) to modify the user.

Request

Supported Media Types

application/json

Query Parameters

page: integer

A page number within the paginated result set.
page_size: integer

Number of results to return per page.
search: string

A search term.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

count(required): integer
next: string(uri)
previous: string(uri)
results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/User"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

Array of: object User

{
    "items":{
        "$ref":"#/definitions/User"
    },
    "type":"array"
}

Nested Schema : User

Type: object

Show Source

created: string

Title: Created

Read Only: true
email: string

Title: Email address

Maximum Length: 254
external_account: string

Title: External account

Read Only: true

Set if the account is managed by an external service
first_name: string

Title: First name

Maximum Length: 150
id: integer

Title: ID

Read Only: true
is_superuser: boolean

Title: Superuser status

Designates that this user has all permissions without explicitly assigning them.
is_system_auditor: boolean

Title: Is system auditor
last_login: string(date-time)

Title: Last login

Read Only: true
last_name: string

Title: Last name

Maximum Length: 150
ldap_dn: string

Title: Ldap dn

Read Only: true

Minimum Length: 1
modified: string

Title: Modified

Read Only: true
password: string

Title: Password

Minimum Length: 1

Field used to change the password.
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
username(required): string

Title: Username

Minimum Length: 1

Maximum Length: 150

Pattern: ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "email":{
            "maxLength":"254",
            "title":"Email address",
            "type":"string",
            "x-nullable":true
        },
        "external_account":{
            "description":"Set if the account is managed by an external service",
            "readOnly":true,
            "title":"External account",
            "type":"string"
        },
        "first_name":{
            "maxLength":"150",
            "title":"First name",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "is_superuser":{
            "description":"Designates that this user has all permissions without explicitly assigning them.",
            "title":"Superuser status",
            "type":"boolean",
            "x-nullable":true
        },
        "is_system_auditor":{
            "title":"Is system auditor",
            "type":"boolean"
        },
        "last_login":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last login",
            "type":"string",
            "x-nullable":true
        },
        "last_name":{
            "maxLength":"150",
            "title":"Last name",
            "type":"string",
            "x-nullable":true
        },
        "ldap_dn":{
            "minLength":"1",
            "readOnly":true,
            "title":"Ldap dn",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "password":{
            "description":"Field used to change the password.",
            "minLength":"1",
            "title":"Password",
            "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"
        },
        "username":{
            "description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength":"150",
            "minLength":"1",
            "pattern":"^[\\w.@+-]+$",
            "title":"Username",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "username"
    ],
    "type":"object"
}