Jump to

• Request
• Response

Update auth user attributes by user ID

put

/ec-auth-svc/rest/v1.0/authusers/{userid}/locale

Updates the user's locale preference for UI and communication. Provide a list of locale attributes for the user. All attributes are fully replaced with the provided list.

Request

Path Parameters

• userid(required): string(uuid)
  UUID of the user for which the locale is to be updated.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Key-value pair for user attribute

Show Source

• key: string
  The attribute key name

  Example: Locale
• value: string
  The value of the attribute

  Example: en-US

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The attribute key name",
            "example":"Locale"
        },
        "value":{
            "type":"string",
            "description":"The value of the attribute",
            "example":"en-US"
        }
    },
    "description":"Key-value pair for user attribute",
    "example":{
        "key":"Locale",
        "value":"en-US"
    }
}

Example:

{
    "key":"Locale",
    "value":"en-US"
}

Examples

Select an example Payload

Back to Top

Response

Supported Media Types

• application/json

200 Response

User locale updated. Returns updated list of user attributes.

Body ()

Root Schema : schema

Type: object

Key-value pair for user attribute

Show Source

• key: string
  The attribute key name

  Example: Locale
• value: string
  The value of the attribute

  Example: en-US

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The attribute key name",
            "example":"Locale"
        },
        "value":{
            "type":"string",
            "description":"The value of the attribute",
            "example":"en-US"
        }
    },
    "description":"Key-value pair for user attribute",
    "example":{
        "key":"Locale",
        "value":"en-US"
    }
}

Example:

{
    "key":"Locale",
    "value":"en-US"
}

Examples

Select an example updated

400 Response

Bad request. Invalid input data.

Body ()

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result data of the API response; actual type depends on the API
• status: string (none)
  Indicates request success ("success") or failure ("failure").

  Example: success
• version: integer (int32)
  Version of the response schema.

  Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@1466a41f

Nested Schema : details

Type: object

Back to Top