Permission API › Tournament permissions

Download OpenAPI 3.0

Endpoints

GET /tournaments/{tournament_id}/permissions

Returns the complete list of permissions of a tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/permissions

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:permission scope (see Authorization)

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Success

Example
[
    {
        "id": "378436939507009728",
        "email": "[email protected]",
        "attributes": [
            "report",
            "place",
            "register"
        ]
    }
]
Structure (collection)
  • id
    string

    The permission identifier.

    Example: "378436939507009728"

  • email
    string

    Email of the user.

    Example: "[email protected]"

  • attributes
    array[string]

    The list of permissions of the user in the tournament.

    Possible values: admin, setup, structure, report, fill, place, register, standing

POST /tournaments/{tournament_id}/permissions

Creates a new user permission in a tournament. You can not have more than 128 permissions in a tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/permissions

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:permission scope (see Authorization)

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Permission data

Example
{
    "email": "[email protected]",
    "attributes": [
        "report",
        "place",
        "register"
    ]
}
Structure (object)
  • email
    string

    Email of the user.

    Example: "[email protected]"

  • attributes
    array[string]

    The list of permissions of the user in the tournament.

    Possible values: admin, setup, structure, report, fill, place, register, standing

Response

[201] Success

Example
{
    "id": "378436939507009728",
    "email": "[email protected]",
    "attributes": [
        "report",
        "place",
        "register"
    ]
}
Structure (object)
  • id
    string

    The permission identifier.

    Example: "378436939507009728"

  • email
    string

    Email of the user.

    Example: "[email protected]"

  • attributes
    array[string]

    The list of permissions of the user in the tournament.

    Possible values: admin, setup, structure, report, fill, place, register, standing

GET /tournaments/{tournament_id}/permissions/{id}

Returns a single user permission of a tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/permissions/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:permission scope (see Authorization)

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

  • id
    string

    The identifier of the permission.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Success

Example
{
    "id": "378436939507009728",
    "email": "[email protected]",
    "attributes": [
        "report",
        "place",
        "register"
    ]
}
Structure (object)
  • id
    string

    The permission identifier.

    Example: "378436939507009728"

  • email
    string

    Email of the user.

    Example: "[email protected]"

  • attributes
    array[string]

    The list of permissions of the user in the tournament.

    Possible values: admin, setup, structure, report, fill, place, register, standing

PATCH /tournaments/{tournament_id}/permissions/{id}

Updates the rights of a user permission.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/permissions/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:permission scope (see Authorization)

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

  • id
    string

    The identifier of the permission.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Permission data

Example
{
    "attributes": [
        "report",
        "place",
        "register"
    ]
}
Structure (object)
  • attributes
    array[string]

    The list of permissions of the user in the tournament.

    Possible values: admin, setup, structure, report, fill, place, register, standing

Response

[200] Success

Example
{
    "id": "378436939507009728",
    "email": "[email protected]",
    "attributes": [
        "report",
        "place",
        "register"
    ]
}
Structure (object)
  • id
    string

    The permission identifier.

    Example: "378436939507009728"

  • email
    string

    Email of the user.

    Example: "[email protected]"

  • attributes
    array[string]

    The list of permissions of the user in the tournament.

    Possible values: admin, setup, structure, report, fill, place, register, standing

DELETE /tournaments/{tournament_id}/permissions/{id}

Deletes a user permissions from a tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/permissions/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:permission scope (see Authorization)

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

  • id
    string

    The identifier of the permission.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[204] Success