AuthMe
  1. User Identities
AuthMe
  • Getting Started
  • User Identities
    • Create Identity
      POST
    • Retrieve an Identity
      POST
    • Generate Param
      POST
    • User identification
      POST
    • Login user
      POST
    • Login legacy user
      POST
    • Authenticate user by param
      POST
    • User remember-me
      POST
    • User renovate-token
      POST
    • User associate-user-device
      POST
    • Generates token when user navigates between applications
      POST
    • Generates an Access token
      POST
    • Renew Token
      POST
    • Create password
      POST
    • Change Password
      POST
    • Reset password
      POST
    • Get Identities from user
      GET
    • Remove Identity
      DELETE
    • Updates specific identity attributes
      PATCH
    • Provision logon in mainframe
      POST
    • Lock an user credential
      POST
    • Unlock an user credential
      POST
    • Remove Identity
      DELETE
    • Add Identity
      PATCH
    • Leverage MFA
      POST
    • Fulfill MFA
      POST
    • Generate token to login with digital certificate
      POST
    • Authenticate with digital certificate
      POST
    • Generate a renew app token based on SAML integration informed data
      POST
    • Associate legacy logon by email
      POST
    • Associate legacy logon by mobile
      POST
    • Complete Associate legacy logon
      POST
    • Retrieve a legacy identity
      POST
    • Reset a legacy identity
      POST
    • Add alternative contacts to use on MFA process
      POST
    • Retrieve all user authentication factors
      GET
    • Update an alternative contact to use on MFA process
      PUT
    • Delete an alternative contact
      DELETE
    • Send a token to an authentication factor
      POST
    • Validate a Token previously sent to an authentication factor.
      POST
    • Grant Auth Smart Role
      POST
    • Login using federated accounts
      POST
    • Add alternative contacts to use on MFA process
      POST
    • Partial update to alternative contact to use on MFA process with adminstrative roles.
      PATCH
    • Delete an alternative contact with administrative roles
      DELETE
  • Client Identities
    • Create Identity
    • Remove Identity
    • Bulk Migrates Client Identities Organizational Structure
    • Login client
    • Login client
  • My Client Identities
    • Create Identity
    • Remove Client Identity
  • User Accesses
    • Groups - List Users
    • Groups - Add User
    • Groups - Remove User
    • Groups - List Business Users
    • Groups - Add Business User
    • Groups - Remove Business User
    • List User Roles
  • Business Accesses
    • Groups - List Business
    • Groups - Add Business
    • Groups - Remove Business
    • List Business Roles
  • Service Accesses
    • Groups - List Services
    • Groups - Add Service
    • Groups - Remove Service
    • List Service Roles
  • Product Accesses
    • Generate Opaque Token
    • Validate Opaque Token
  • Keys
    • Gets public key used to validate JWT
  • Corporate Groups
    • Creates a corporate group
    • Lists corporate groups
    • Gets corporate group by id
    • Updates a corporate group
    • Deletes a corporate group
  • Customer
    • Creates a Business Customer
    • Creates a User Customer
  • Identific
    • Create a new ApiKey for the Identific
    • List all ApiKey
    • Update an ApiKey
    • Delete an ApiKey
  • Groups
    • Creates a group
    • Lists groups
    • Gets group by id
    • Updates a group
    • Delete a group.
    • Creates a group role.
    • Deletes a group role.
    • Creates a group dependency.
    • Deletes a group dependency.
  • Generate Token
    • Generate a access token and a refresh token
  1. User Identities

Generate a renew app token based on SAML integration informed data

Prod Env
https://api.serasaexperian.com.br
Prod Env
https://api.serasaexperian.com.br
POST
https://api.serasaexperian.com.br
/security/iam/v1/user-identities/handle-auth
User Identities

Responsibilities#

Generate a renew app token based on SAML integration informed data.

Requirements#

To access this endpoint, you must have:
One of the following sets of roles:
CLI-AUTH-BASIC and CLI-1STPARTY
One of the following sets of scopes:
SAML_SSO
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.serasaexperian.com.br/security/iam/v1/user-identities/handle-auth?clientId' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "my-email@email.com",
    "mainframeLogon": "ABC1234",
    "fullName": "Full Name Test",
    "businessId": "60773aa94a50c11cfe00314d",
    "groups": [
        "IDC_GERENCIADOR_MANAGER"
    ]
}'
Response Response Example
200 - Example 1
{
    "validationToken": "string",
    "originClientId": "string",
    "userId": "string",
    "ip": "string"
}

Request

Query Params
clientId
string 
required
Client ID registered to identify
Body Params application/json
email
string 
required
Example:
my-email@email.com
mainframeLogon
string 
optional
Example:
ABC1234
fullName
string 
optional
Example:
Full Name Test
businessId
string 
optional
Example:
60773aa94a50c11cfe00314d
groups
array[string]
required
Examples

Responses

🟢200OK
application/json
Digital Certicate Authentication Authorized
Body
validationToken
string 
required
Validation token returned in /user-identities/change-app
originClientId
string 
required
Origin application
userId
string 
required
User ID from origin token
ip
string 
optional
Origin IP address. If nothing is passed by the request, it will be filled automatically by HeadersIpParamBody policy that gets the caller IP address from X-Forwarded-For header.
🟠400Bad Request
🟠401Unauthorized
🟠412412
🔴500Server Error
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-04-11 12:00:41
Previous
Authenticate with digital certificate
Next
Associate legacy logon by email
Built with