Permissions

GET /tournaments/{tournament_id}/permissions

Authorized Access

Returns a collection of permission from one tournament.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

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

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[200] Success

Example
[
    {
        "id": "378436939507009728",
        "email": "tournament.admin@team.com",
        "attributes": [
            "report",
            "place",
            "register"
        ]
    }
]
Structure (collection)
  • id
    string

    The permission identifier.

    Example: "378436939507009728"

  • email
    string

    Email of the permitted user.

    Example: "tournament.admin@team.com"

  • attributes
    array[string]

    The list of permission of the related user on the tournament.

    Possible values: edit, delete, authorize, report, fill, place, register

POST /tournaments/{tournament_id}/permissions

Authorized Access

Create a permission for a user on a tournament.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

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

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Create a permission

Example
{
    "email": "tournament.admin@team.com",
    "attributes": [
        "report",
        "place",
        "register"
    ]
}
Structure (object)
  • email
    string

    Email of the permitted user.

    Example: "tournament.admin@team.com"

  • attributes
    array[string]

    The list of permission of the related user on the tournament.

    Possible values: edit, delete, authorize, report, fill, place, register

Response

[201] Success

Example
{
    "id": "378436939507009728",
    "email": "tournament.admin@team.com",
    "attributes": [
        "report",
        "place",
        "register"
    ]
}
Structure (object)
  • id
    string

    The permission identifier.

    Example: "378436939507009728"

  • email
    string

    Email of the permitted user.

    Example: "tournament.admin@team.com"

  • attributes
    array[string]

    The list of permission of the related user on the tournament.

    Possible values: edit, delete, authorize, report, fill, place, register

GET /tournaments/{tournament_id}/permissions/{permission_id}

Authorized Access

Retrieves a permission of a tournament.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

https://api.toornament.com/v1/tournaments/{tournament_id}/permissions/{permission_id}

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

  • permission_id
    string

    The identifier of the permission.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[200] Success

Example
{
    "id": "378436939507009728",
    "email": "tournament.admin@team.com",
    "attributes": [
        "report",
        "place",
        "register"
    ]
}
Structure (object)
  • id
    string

    The permission identifier.

    Example: "378436939507009728"

  • email
    string

    Email of the permitted user.

    Example: "tournament.admin@team.com"

  • attributes
    array[string]

    The list of permission of the related user on the tournament.

    Possible values: edit, delete, authorize, report, fill, place, register

PATCH /tournaments/{tournament_id}/permissions/{permission_id}

Authorized Access

Update rights of a permission.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

https://api.toornament.com/v1/tournaments/{tournament_id}/permissions/{permission_id}

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

  • permission_id
    string

    The identifier of the permission.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

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

    The list of permission of the related user on the tournament.

    Possible values: edit, delete, authorize, report, fill, place, register

Response

[200] Success

Example
{
    "id": "378436939507009728",
    "email": "tournament.admin@team.com",
    "attributes": [
        "report",
        "place",
        "register"
    ]
}
Structure (object)
  • id
    string

    The permission identifier.

    Example: "378436939507009728"

  • email
    string

    Email of the permitted user.

    Example: "tournament.admin@team.com"

  • attributes
    array[string]

    The list of permission of the related user on the tournament.

    Possible values: edit, delete, authorize, report, fill, place, register

DELETE /tournaments/{tournament_id}/permissions/{permission_id}

Authorized Access

Delete a user permission of a tournament.

Warning! This endpoint can only be used with an Authorized Access.

Resource URL

https://api.toornament.com/v1/tournaments/{tournament_id}/permissions/{permission_id}

Path parameters

  • tournament_id
    string

    The identifier of the tournament.

  • permission_id
    string

    The identifier of the permission.

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[204] Success