API Scripts are recommended to use the Login call instead of separate Authentication & Authorization calls.
First step for logging in is sending the credentials and retrieving partial AuthToken. If the response has the "needTwoFactorAuth:true", then either API user must be extempt from Admin MFA or two-step MFA process must be completed before Authorization.
Login Credentials.
Display name of the Identity Provider name.
Username. Required if a credentials based Identity Provider is used.
Password. Required if a credentials based Identity Provider is used.
UUID to distinguish the Client device making the request. It is supposed to be same for every login request from the same server.
SAMLResponse received from SAML provider. Required if a SAML based Identity Provider is used.
ID Token received from OIDC provider. Required if an OIDC based Identity Provider is used and the provider does not have a client secret (public client flow).
Access Token received from OIDC provider. Optional for OIDC authentication.
OIDC authorization code exchange parameters. Required if an OIDC based Identity Provider is used and the provider has a client secret configured (backend token exchange flow).
Authorization code received from OIDC provider after user authentication.
Redirect URI used in authorization request. Must match exactly for OAuth security.
PKCE code verifier generated by client.
Login Response.
Information about logged in user, such as username and email address, if exists.
Username.
If true, it is not possible to complete login process without providing MFA.
Whether there is a LogServer deployed and the user has privileges to access to it.
The AuthToken required for subsequent API calls.
Token expiration time.
Rotated replication access token. For internal use.
Next replication access token. For internal use.
JSON error. Check the JSON format.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Login Failed.
Machine readable error code.
Human readable error details.
The authentication failure reason.
Invalid 'Accept' header.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Request validation error. Check "errors" array for details.
Http 422 error for object validation.
Machine readable error code.
Human readable error details.
List of fields with validation errors.
Name of the field that failed validation.
Failure reason.
Name of the field that should be displayed in the UI. It's an internal field to be used by the local replication service.
Message to be displayed in the replication UI. It's an internal field to be used by the local replication service.
Unexpected server side error.
Generic HTTP error.
Machine readable error code.
Human readable error details.