AuthMe
  1. Groups
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
      POST
    • Lists groups
      GET
    • Gets group by id
      GET
    • Updates a group
      PUT
    • Delete a group.
      DELETE
    • Creates a group role.
      POST
    • Deletes a group role.
      DELETE
    • Creates a group dependency.
      POST
    • Deletes a group dependency.
      DELETE
  • Generate Token
    • Generate a access token and a refresh token
  1. Groups

Gets group by id

Prod Env
https://api.serasaexperian.com.br
Prod Env
https://api.serasaexperian.com.br
GET
https://api.serasaexperian.com.br
/security/iam/v1/groups/{groupId}
Groups

Responsibilities#

This endpoint has the function of get an active group by id.

Requirements#

To access this endpoint, the client (application) must have one of the following sets of roles:
CLI-AUTH-IDENTIFIED and CLI-1STPARTY and AUTH-BASIC and ROLE_IAM_ADMIN_READ_ONLY
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.serasaexperian.com.br/security/iam/v1/groups/'
Response Response Example
200 - Example 1
{
    "id": "6234caa6ab14624d4807d6ac",
    "groupName": "SECADMIN",
    "organizationId": "6234caa6ab14624d4807d6ac",
    "businessUnitId": "5aa2f9e0da484d24c056e861",
    "type": "User Accounts",
    "roles": [
        "ROLE_USER"
    ],
    "dependencies": [
        {
            "groupName": "BUSINESSADMIN"
        }
    ]
}

Request

Path Params
groupId
string 
required
Group Id

Responses

🟢200OK
application/json
Ok
Body
id
string 
optional
Group response ID
Example:
6234caa6ab14624d4807d6ac
groupName
string 
optional
Group name
Example:
SECADMIN
organizationId
string 
optional
Organization Id
Example:
6234caa6ab14624d4807d6ac
businessUnitId
string 
optional
Business Unit Id
Example:
5aa2f9e0da484d24c056e861
type
string 
optional
Type of group
Example:
User Accounts
roles
array[string]
optional
Role name which represents the group within IAM
dependencies
array[object (Dependencies) {1}] 
optional
Dependencies of the group
groupName
string 
required
Unique identifier
>= 1 characters
Example:
BUSINESSADMIN
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
🔴500Server Error
Modified at 2025-04-11 12:00:41
Previous
Lists groups
Next
Updates a group
Built with