Get Local Account

Get Local Account

Get information on the local account

Request
URI
GET
https://{api_host}/v1/users/local/admin
COPY
Responses
200

OK

Returns LocalUser of type(s) application/json 
{
    "isConfigured": false,
    "id": "string",
    "name": "string",
    "domain": "string",
    "type": "One among: USER, GROUP, SERVICE",
    "apiKey": "string",
    "role": {
        "id": "string"
    },
    "creationTimestamp": "string"
}
boolean
isConfigured
Optional

Flag indicating whether or not local account is configured

string
id
Optional

The ID of the user

string
name
Required

The name of the user

string
domain
Optional

The domain of the user

string
type
Required

The type of the user

string
apiKey
Optional

The API key of the user

RoleReference
role
Required

Represents a role reference

string
creationTimestamp
Optional

The timestamp at which the user was created


400

Bad request

Returns ErrorResponse of type(s) application/json 
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken


401

Unauthorized Request

Returns ErrorResponse of type(s) application/json 
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken


500

Internal Server Error

Returns ErrorResponse of type(s) application/json 
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken


On This Page
Users Operations
POST
Add Users
DELETE
Disable Local Account
GET
Get Local Account
GET
Get Roles
GET
Get SSO Domain Entities
GET
Get SSO Domains
GET
Get Ui Users
GET
Get Users
DELETE
Remove User
PATCH
Update Local User Password