ex_heroku_client v0.1.0 Heroku.OauthClient

Summary

Functions

Calls POST /oauth/clients

Calls DELETE /oauth/clients/#{oauth-client_identity}

Calls GET /oauth/clients/#{oauth-client_identity}

Calls GET /oauth/clients

Calls PATCH /oauth/clients/#{oauth-client_identity}

Calls POST /oauth/clients/#{oauth-client_identity}/actions/rotate-credentials

Functions

create(params)

Calls POST /oauth/clients

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "name": {
      "description": "OAuth client name",
      "example": "example",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "redirect_uri": {
      "description": "endpoint for redirection after authorization with OAuth client",
      "example": "https://example.com/auth/heroku/callback",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "name",
    "redirect_uri"
  ],
  "type": [
    "object"
  ]
}
destroy(oauth-client_identity)

Calls DELETE /oauth/clients/#{oauth-client_identity}

get(oauth-client_identity)

Calls GET /oauth/clients/#{oauth-client_identity}

index()

Calls GET /oauth/clients

update_5(oauth-client_identity, params \\ %{})

Calls PATCH /oauth/clients/#{oauth-client_identity}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "name": {
      "description": "OAuth client name",
      "example": "example",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "redirect_uri": {
      "description": "endpoint for redirection after authorization with OAuth client",
      "example": "https://example.com/auth/heroku/callback",
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}
update_6(oauth-client_identity)

Calls POST /oauth/clients/#{oauth-client_identity}/actions/rotate-credentials