Skip to main content

Edit existing auth client

PUT 
/auth/api/login/client/:id

Updates the auth client with the given ID. Only parameter given in the input will be changed.

If redirectUrls is given, it wil replace all previous URLs. Merging (if needed) needs to be done by the client.

Request​

Path Parameters

    id uuidrequired

    The uuid string of an existing auth client

Body

required
    name string

    The name to set for the auth client.

    If given, must be non empty

    redirectUrls string[]

    A list of url strings containing at least one url. These are the URLs the oauth autorize endpoint will redirect back to

    Defaults to [] on create

    isValid boolean

    If given, sets the validity flag of the auth client.

    Defaults to true on create

    requiresSecret boolean

    If given, setns the need for the client to authenticate using a secret

    Defaults to true on create

    validScopes string[]

    Possible values: [login, login-register, backend, auth]

    The list of scopes that this client is allowed to request.

    Defaults to [] on create

    clientCredentialFlowUser string

    The user to use as subject for the client credential flow.

Responses​

The auth client was successfully updated

Schema
    id stringrequired

    The unique ID of this client

    name stringrequired

    The (human readable) name of the auth client to be able to keep track ofit.

    Doesn't need to be unique

    redirectUrls string[]required

    The list of valid enpoints to redirect the user back to after authentication has finished.

    The actual url to use is given in the authorize request and must be included in this list. If none is given, the first one from this list will be used

    isValid booleanrequired

    If this is false the client is not valid and no authorization, token, ... requests from it should be answered.

    requiresSecret booleanrequired

    If true requesting a token as this client requires the use of a client secret accoring to the oauth specification.

    If false client secrets can be present and given but are not required

    validScopes string[]required

    Possible values: [login, login-register, backend, auth]

    The list of scopes that this client is allowed to request.

    isInternal booleanrequired

    Default value: false

    If this client is editable. If not, the client can not be changed or deleted.

Loading...