{
"opencollection": "1.0.0",
"info": {
"name": "Auth0 Authentication actions client-grants API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "client-grants",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Client Grants",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/client-grants",
"params": [
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "audience",
"value": "",
"type": "query",
"description": "Optional filter on audience."
},
{
"name": "client_id",
"value": "",
"type": "query",
"description": "Optional filter on client_id."
},
{
"name": "allow_any_organization",
"value": "",
"type": "query",
"description": "Optional filter on allow_any_organization."
},
{
"name": "subject_type",
"value": "",
"type": "query",
"description": "The type of application access the client grant allows."
},
{
"name": "default_for",
"value": "",
"type": "query",
"description": "Applies this client grant as the default for all clients in the specified group. The only accepted value is `third_party_clients`, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with `client_id`."
}
]
},
"docs": "Retrieve a list of client grants, including the scopes associated with the application/API pair.\n"
},
{
"info": {
"name": "Create Client Grant",
"type": "http"
},
"http": {
"method": "POST",
"url": "{auth0_domain}/client-grants",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow."
},
{
"info": {
"name": "Get Client Grant",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/client-grants/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the client grant to retrieve."
}
]
},
"docs": "Retrieve a single client grant, including the\nscopes associated with the application/API pair.\n"
},
{
"info": {
"name": "Update Client Grant",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{auth0_domain}/client-grants/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client grant to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a client grant."
},
{
"info": {
"name": "Delete Client Grant",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{auth0_domain}/client-grants/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client grant to delete."
}
]
},
"docs": "Delete the Client Credential Flow from your machine-to-machine application.\n"
},
{
"info": {
"name": "Get the Organizations Associated to a Client Grant",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/client-grants/:id/organizations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client grant"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
]
},
"docs": "Get the Organizations Associated to a Client Grant"
}
]
}
],
"bundled": true
}