Jump to

• Request
• Response

Update a global user's roles

put

/ec-auth-svc/rest/v1.0/globalusers/{userid}/roles

Assign or update the list of global roles for a given user. Request body is a JSON array of role UUIDs. Each UUID must be a 32-character hexadecimal value corresponding to a global role. Returns the newly assigned global roles for the user.

Request

Path Parameters

• userid(required): string(uuid)
  User ID.

  Example:

  94A7C1C2049A4C1590AB52F757AD25A3

Query Parameters

• localize: boolean
  Default Value: false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: string(uuid)
  Example: 821DEE0FC2204E7A86BCC65A597F7815

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid",
        "example":"821DEE0FC2204E7A86BCC65A597F7815"
    }
}

Examples

Select an example Role assignment by UUID list

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DisplayUserRoleDto
  Associates a user with a global role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DisplayUserRoleDto"
    }
}

Nested Schema : DisplayUserRoleDto

Type: object

Associates a user with a global role.

Show Source

• id: string (uuid)
  Unique identifier for this user-role association.
• roleName: string
  Name of the role assigned to the user.

  Example: STUDY_MANAGER

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for this user-role association.",
            "format":"uuid"
        },
        "roleName":{
            "type":"string",
            "description":"Name of the role assigned to the user.",
            "example":"STUDY_MANAGER"
        }
    },
    "description":"Associates a user with a global role.",
    "example":{
        "id":"A519EF3C2B73455390CFF812AFF61519",
        "roleName":"STUDY_MANAGER"
    }
}

Example:

{
    "id":"A519EF3C2B73455390CFF812AFF61519",
    "roleName":"STUDY_MANAGER"
}

Examples

Select an example The user's assigned global roles after update

400 Response

Bad request

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