Assign roles to a user

PATCH

{baseUrlRole}/v2/users/{userId}/agflow-role

Assigns one or more roles to a user.

Alternate base URL particularity: unlike the other endpoints in this and other AgFlow API domains, this endpoint does not serve on the API's standard base URL — the {baseUrlRole} segment represents an alternate URL base, dedicated to user identity/role operations, distinct from the base used by the other endpoints. When integrating, you must configure and use the appropriate base URL for this specific operation; using the standard AgFlow API base here results in a connection failure or a non-existent route.

The request body contains the complete list of role identifiers (roles) the user should have. The operation fully replaces the user's current role list — it does not merge (append) with roles already assigned. To add a new role without losing existing ones, you must first retrieve the user's currently assigned roles and resend, in this call, the complete list (existing roles plus the new one).

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Roles assigned

application/json

The user's roles were successfully replaced with the submitted list.

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v2/users//agflow-role' \
--header 'Content-Type: application/json' \
--data '{
    "roles": [
        "string"
    ]
}'

Response Example

{
    "userId": "string",
    "roles": [
        "string"
    ]
}

Modificado em 2026-07-28 20:38:32

Página anterior

Generate company logo download URL

Próxima página

Documents — Overview