Get SSO Domain Entities

Get a list of all entities in the SSO domain

Request

URI

GET

https://{api_host}/v1/sso-domains/{sso-domain}/entities

COPY

Path Parameters

string

sso-domain

Required

SSO Domain Name

Query Parameters

string

entityName

Optional

Search Criteria for the users and groups

Responses

200

Returns PageOfSsoDomainEntity of type(s) application/json

{
    "elements": [
        {
            "id": "string",
            "name": "string",
            "type": "One among: USER, GROUP"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

array of SsoDomainEntity

elements

Optional

The list of elements included in this page

PageMetadata

pageMetadata

Optional

Represents pageable elements pagination metadata

401

Unauthorized Request

Returns ErrorResponse of type(s) application/json

{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

errorCode

array of string

arguments

Optional

arguments

object

context

Optional

context

string

message

Optional

message

string

remediationMessage

Optional

remediationMessage

array of ErrorCause

cause

Optional

cause

array of ErrorResponse

nestedErrors

Optional

nestedErrors

string

referenceToken

Optional

referenceToken

403

Forbidden request

Returns ErrorResponse of type(s) application/json

{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

errorCode

array of string

arguments

Optional

arguments

object

context

Optional

context

string

message

Optional

message

string

remediationMessage

Optional

remediationMessage

array of ErrorCause

cause

Optional

cause

array of ErrorResponse

nestedErrors

Optional

nestedErrors

string

referenceToken

Optional

referenceToken

500

Internal Server Error

Returns ErrorResponse of type(s) application/json

{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

errorCode

array of string

arguments

Optional

arguments

object

context

Optional

context