SSO Clients Groups

Download OpenAPI specification:Download

Configure Mosaic SSO Service to streamline login for users. Create and manage SSO clients group to control your SSO login experience.

Create clients group

Creates a new SSO clients group.

Required permissions: sso-service:edit.

SecurityOAuth2: ClientAccessToken
Request
Request Body schema: application/json
required
name
required
string

Name of the clients group

description
string

Short description of the clients group

required
object

Configuration of the clients group

Responses
201
post/v1/sso-service/sso-group
Request samples
application/json
{
  • "name": "My Clients Group",
  • "description": "string",
  • "configuration": {
    }
}
Response samples
application/json
{
  • "result": {
    }
}

Get all clients groups

Retrieves a list of all clients groups.

Required permissions: sso-service:read.

SecurityOAuth2: ClientAccessToken
Responses
200
get/v1/sso-service/sso-group
Request samples 
Response samples 
application/json
{
  • "result": [
    ]
}
Get clients group by ID
Retrieves a clients group by its ID. The clients group ID is a unique identifier for a clients group. 

Required permissions: sso-service:read.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
groupId
required
string
ID of the group to retrieve


 
Responses 
200
404
SSO Service Not Found


get/v1/sso-service/sso-group/{groupId}
Request samples 
Response samples 
application/json
{
  • "result": {
    }
}
Update clients group
Updates an existing clients group. The clients group ID is a unique identifier for a clients group. 

Required permissions: sso-service:edit.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
groupId
required
string
ID of the group to retrieve


 
Request Body schema: application/json
required
name
required
string
Name of the clients group


 
description
string
Short description of the clients group


 
required
object
Configuration of the clients group


 
Responses 
404
put/v1/sso-service/sso-group/{groupId}
Request samples 
application/json
{
  • "name": "My Clients Group",
  • "description": "string",
  • "configuration": {
    }
}
Response samples 
application/json
{ }
Delete clients group
Deletes a clients group. 

Required permissions: sso-service:edit, sso-service:delete.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
groupId
required
string
ID of the group to retrieve


 
Responses 
204
Clients group deleted


delete/v1/sso-service/sso-group/{groupId}
Request samples 
Delete client
Deletes a client and removes it from the SSO client group. 

Required permissions: sso-service:edit, sso-service:delete.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
groupId
required
string
ID of the group to retrieve


 
clientId
required
string
ID of the client to delete


 
Responses 
204
404
delete/v1/sso-service/sso-group/{groupId}/clients/{clientId}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "error_code": 404
}