Create and get the Magic Link for a user

PUT 
/api/web/v1/users/:userid/magiclink

Create and get the Magic Link for the specified user. Caller requires the MAGICLINKS:ADD permission.

Request

Path Parameters

userid stringrequired

application/json

Body

required

autoSend boolean

Automatically send the Magic Link if the user has a default email or one is specified that matches a configured email.

email string

The email to send the Magic Link to if it exists.

redirectUrl string

Automatically redirect the user to an external URL after completing registration. The URL must match one of the allowed URLs.

Responses

200

Successful

application/json

Schema

Schema

expiryDate date-time

Expiry date of the Magic Link.

url string

The generated Magic Link. This value will only be returned if the administrator has the MAGICLINKCONTENTS:VIEW permission.

Example (from schema)

{
  "expiryDate": "2023-01-01T12:12:12Z",
  "url": "https://mycompany.com/#/?magicToken=1a2b3c4d5e6f7g8h9i"
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...