Teams

>>>

GET /api/v1/teams
Display a list of all teams.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

GET /api/v1/teams/user_owned
Display a list of all teams owned by the current user.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

GET /api/v1/teams/:id
Display a team.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the team to be displayed.

Validations:

  • Must be a String
>>>

POST /api/v1/teams
Create a new team.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
team
optional , nil allowed

Validations:

  • Must be a Hash
team[name]
required

Name of the team.

Validations:

  • Must be a String
team[quota]
optional , nil allowed

Team’s maximum quota in bytes.

Validations:

  • Must be a String
team[quota_mail_sent]
optional , nil allowed
true | false

Indicates whether administrators will be warned via mail when a team exceeds its quota. Default: false.

Validations:

  • Must be a String
>>>

PUT /api/v1/teams/:id
Update a team.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the team to be updated.

Validations:

  • Must be a String
team
optional , nil allowed

Validations:

  • Must be a Hash
team[name]
optional

Name of the team.

Validations:

  • Must be a String
team[quota]
optional , nil allowed

Team’s maximum quota in bytes.

Validations:

  • Must be a String
team[quota_mail_sent]
optional , nil allowed
true | false

Indicates whether administrators will be warned via mail when a team exceeds its quota. Default: false.

Validations:

  • Must be a String
>>>

DELETE /api/v1/teams/:id
Delete a team.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the team to be deleted.

Validations:

  • Must be a String
>>>

POST /api/v1/teams/:team_id/users/:user_id
Add a user to a team.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
user_id
required

ID of the user to be added to a team.

Validations:

  • Must be a String
team_id
required

ID of the team to add the user to.

Validations:

  • Must be a String
>>>

DELETE /api/v1/teams/:team_id/users/:user_id
Remove a user from a team.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
user_id
required

ID of the user to be removed from a team.

Validations:

  • Must be a String
team_id
required

ID of the team from which the user is to be removed.

Validations:

  • Must be a String
>>>

POST /api/v1/users/:user_id/assign_to_all_teams
Assign all users to a team.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the team.

Validations:

  • Must be a String
>>>

DELETE /api/v1/users/:user_id/remove_from_all_teams
Remove all users from a team.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the team.

Validations:

  • Must be a String
>>>

GET /api/v1/teams/:id/access_rights
Return all access rights for the specified team

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
team_id
required

ID of the team

Validations:

  • Must be a String
type
required

“assets” to fetch Asset access rights, “projects” to fetch Project access rights

Validations:

  • Must be a String