GOgooddata
User Authorization

Update a user

Update a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

put/api/v1/auth/users/{userEmail}

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Path parameters

userEmailstring required

Request body

authenticationIdstring

Field which is stored as the authenticationId in metadata. Must be absent on POST. On PUT it must be absent, or equal to the value calculated by the backend (e.g. as returned from a previous GET).

displayNamestring required

User description, which will be visible in application.

emailstring email required

Email - used as lookup (must be unique). For PUT method, it must be same as in URL

passwordstring

User password. Write-only - accepted on POST and PUT, never returned in a response.

Example request

{
  "displayName": "jeremy",
  "email": "zeus@example.com"
}

Response

OK

authenticationIdstring

Field which is stored as the authenticationId in metadata. Must be absent on POST. On PUT it must be absent, or equal to the value calculated by the backend (e.g. as returned from a previous GET).

displayNamestring required

User description, which will be visible in application.

emailstring email required

Email - used as lookup (must be unique). For PUT method, it must be same as in URL

passwordstring

User password. Write-only - accepted on POST and PUT, never returned in a response.

Example response

{
  "displayName": "jeremy",
  "email": "zeus@example.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.