NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

Authentication/User Credentials → Validate

AI-generated

Summary

Validate a NetSapiens username/password or OAuth2 client credentials

Inputs

  • refreshOptions — Whether to bypass cached dropdown values and fetch fresh options
  • ValidateUserCredentials__username (required) — The NetSapiens username to validate
  • ValidateUserCredentials__password (required) — The password for the user to validate
  • ValidateUserCredentials__clientId — OAuth2 client ID to use for validation. If an OAuth2 credential is configured, this is optional and will be read from the credential.
  • ValidateUserCredentials__clientSecret — OAuth2 client secret to use for validation. If an OAuth2 credential is configured, this is optional and will be read from the credential.

Output shape

no body — success/failure only

Throws an error if the credentials are invalid; otherwise resolves silently.

Examples

Example 1: Validate using API Key credentials

Username: alice@example.com, Password: secret, Client ID: (optional), Client Secret: (optional), Refresh Dropdown Cache: false

Example 2: Validate using OAuth2 client credentials

Client ID: myapp.territory, Client Secret: hidden, Username: (none), Password: (none), Refresh Dropdown Cache: true

Example 3: Validate with forced fresh options

Refresh Dropdown Cache: true, Username: user@domain.example.com, Password: ***

Links

Discussion