Links new authentication with any user by id

POST 
/auth/api/login/registration/admin-link

Authorization: apiKey

name: bearertype: apiKeyscheme: bearerbearerFormat: JWTdescription: Access token provided after running the oauth flow (and if needed registering/linking)

Links a new authentication with any user specified by id

Needs admin permissions

A (still) valid registration token is needed. After a successful linking, the expiration of the activeLogin and loginData will be updated accoringly

Request

application/json

Body

required

register_token stringrequired

The register token issued during as result of the oauth registration flow. Scope of the token must contain "login-register".

Must be given.

userIdToLink stringrequired

The uuid string of ae existing LoginUser with which to link the authentication behind the registration token

Responses

200

If successful, the default response with operation 'admin-link'

application/json

Schema

Schema

operation stringrequired

A string representation of the operation performed

result stringrequired

Possible values: [success, failed]

Default value: success

The result of the operation. Defaults to "success"

time date-timerequired

Default value: 2025-04-26T15:49:53.599Z

The time the operation was performed. Defaults to the current date+time

Example (from schema)

{
  "operation": "self-register",
  "result": "success",
  "time": "2025-04-26T15:51:43.430Z"
}

201

application/json

Schema

Schema

operation stringrequired

A string representation of the operation performed

result stringrequired

Possible values: [success, failed]

Default value: success

The result of the operation. Defaults to "success"

time date-timerequired

Default value: 2025-04-26T15:49:53.599Z

The time the operation was performed. Defaults to the current date+time

Example (from schema)

{
  "operation": "self-register",
  "result": "success",
  "time": "2025-04-26T15:51:43.430Z"
}

401

If not an admin is logged in, the given registration token is not/no longer valid or the registration time frame has expired

404

If the specified user id did not match any existing user

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://ccims.github.io/auth/api/login/registration/admin-link' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "register_token": "registration.token.jwt",
  "userIdToLink": "12345678-90ab-cdef-fedc-ab0987654321"
}'

Request Collapse all

Auth

bearer

Body required

{
  "register_token": "registration.token.jwt",
  "userIdToLink": "12345678-90ab-cdef-fedc-ab0987654321"
}

ResponseClear

Click the Send API Request button above and see the response here!