live_help Notes

chrome_reader_mode This resource is paginated by 30 items

settings Params

Param name Description
user_id optional . Must be String

The user id or slug

sort optional . Must be one of: id, name, description, created_at, updated_at.

The sort field. Sorted by id desc by default.

Example:

To sort on roles on the fields created_at on a descending order and updated_at on a ascending order:

...&sort=-created_at,updated_at

filter optional . Must be one of: id, name, description, created_at, updated_at.

Filtering on one or more fields

Example:

To filter on roles with the id field matching a_value or another_value:

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • name (standard field)
  • description (standard field)
  • created_at (standard field)
  • updated_at (standard field)
range optional . Must be one of: id, name, description, created_at, updated_at.

Select on a particular range

Example:

To range on roles with the updated_at field between min_value and max_value:

...&range[updated_at]=min_value,max_value

Rangeable fields:
  • id
  • name
  • description
  • created_at
  • updated_at
page optional . Must be a Hash

The pagination params, as a hash

page[number] optional . Must be Fixnum

The current page

page[size] optional . Must be Fixnum

The number of items per page, defaults to 30, maximum 100

comments powered by <span class='logo-disqus'>Disqus</span>
GET /v2/roles
200
[
  {
    "id": 17,
    "name": "Companies Manager",
    "description": "Manage companies"
  },
  {
    "id": 16,
    "name": "Official App",
    "description": "Approved application without rate limits"
  },
  {
    "id": 15,
    "name": "Achievements Manager",
    "description": "Manage users achievements and titles"
  }
]
curl  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.intra.42.fr/v2/roles"

[
  {
    "id": 17,
    "name": "Companies Manager",
    "description": "Manage companies"
  },
  {
    "id": 16,
    "name": "Official App",
    "description": "Approved application without rate limits"
  },
  {
    "id": 15,
    "name": "Achievements Manager",
    "description": "Manage users achievements and titles"
  }
]
require "oauth2"
UID = "Your application uid"
SECRET = "Your application secret"
client = OAuth2::Client.new(UID, SECRET, site: "https://api.intra.42.fr")
token = client.client_credentials.get_token

response = token.get("/v2/roles")
response.status
# => 200
response.parsed
# => [{"id"=>17, "name"=>"Companies Manager", "description"=>"Manage companies"}, {"id"=>16, "name"=>"Official App", "description"=>"Approved application without rate limits"}, {"id"=>15, "name"=>"Achievements Manager", "description"=>"Manage users achievements and titles"}]