Skip to content

Latest commit

 

History

History
69 lines (58 loc) · 2 KB

File metadata and controls

69 lines (58 loc) · 2 KB
description
This endpoint allows you to verify the whitelist of a community account.

Verify Whitelist

{% swagger method="post" path="/servers/verify_whitelist" baseUrl="https://api.sonorancms.com" summary="Verify Whitelist" %} {% swagger-description %} Verifies the whitelist of a community account found given the accId or API ID. {% endswagger-description %}

{% swagger-parameter in="body" name="id" type="string" %} Community ID {% endswagger-parameter %}

{% swagger-parameter in="body" name="key" type="string" %} API Key {% endswagger-parameter %}

{% swagger-parameter in="body" name="type" type="string" %} GET_GAME___SERVERS {% endswagger-parameter %}

{% swagger-parameter in="body" name="data" type="array" %}

{% endswagger-parameter %}

{% swagger-response status="200: OK" description="The following text responses may be sent in response:" %}

{{Sonoran CMS Account Username}}
BYPASSED WHITELIST - {{Sonoran CMS Account Username}}

{% endswagger-response %}

{% swagger-response status="400: Bad Request" description="The following text responses may be sent in response:" %}

{
    "status": 400,
    "message": "VALID BAD REQUEST REASON"
}

{% endswagger-response %}

{% swagger-response status="404: Not Found" description="The following text responses may be sent in response:" %}

NOT ALLOWED ON WHITELIST

{% endswagger-response %} {% endswagger %}

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "VERIFY_WHITELIST",
    "data": [
        {
            // User Identification
            "apiId": "SOME_API_ID", // Optional - must have one
            "username": "SOMEUSERNAME", // Optional - must have one
            "accId": "SOMEACCID", // Optional - must have one
            "discord": "111122223333444455", // Optional - must have one
            "uniqueId": 1234 // Optional - must have one
            // Configuration
            "serverId": 2 // Optional - will check specific server whitelist if specified
        }
    ]
}