List UserGroupLinkSettings

GET

/user-group-link-settings

User Groups

Request

Query Params

userGroupId

string

optional

include

array[string]

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

array[object (UserGroupLinkSettings) {4}]

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

UserGroupLinkSettings

Example:

UserGroupLinkSettings

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "UserGroupLinkSettings",
            "attributes": {
                "message": "string",
                "code": "string",
                "enabled": true,
                "public": true
            },
            "relationships": {
                "userGroup": {
                    "data": {
                        "id": "FID001",
                        "type": "UserGroup"
                    }
                }
            }
        }
    ],
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-07-08 10:51:22

Create UserGroupLinkAccess

Create UserGroupLinkSetting