ex_heroku_client v0.3.0 Heroku.OauthAuthorization

Summary

Functions

Calls POST /oauth/authorizations

Calls DELETE /oauth/authorizations/#{oauth_authorization_identity}

Calls GET /oauth/authorizations/#{oauth_authorization_identity}

Calls GET /oauth/authorizations

Calls POST /oauth/authorizations/#{oauth_authorization_identity}/actions/regenerate-tokens

Functions

create(params)

Calls POST /oauth/authorizations

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "client": {
      "anyOf": [
        {
          "description": "unique identifier of this OAuth client",
          "example": "01234567-89ab-cdef-0123-456789abcdef",
          "format": "uuid",
          "readOnly": true,
          "type": [
            "string"
          ]
        }
      ]
    },
    "description": {
      "description": "human-friendly description of this OAuth authorization",
      "example": "sample authorization",
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "expires_in": {
      "description": "seconds until OAuth token expires; may be `null` for tokens with indefinite lifetime",
      "example": 2592000,
      "readOnly": true,
      "type": [
        "null",
        "integer"
      ]
    },
    "scope": {
      "additionalItems": true,
      "description": "The scope of access OAuth authorization allows",
      "example": [
        "global"
      ],
      "items": {
        "type": [
          "string"
        ]
      },
      "readOnly": true,
      "type": [
        "array"
      ]
    }
  },
  "required": [
    "scope"
  ],
  "type": [
    "object"
  ]
}
destroy(oauth_authorization_identity)

Calls DELETE /oauth/authorizations/#{oauth_authorization_identity}

get(oauth_authorization_identity)

Calls GET /oauth/authorizations/#{oauth_authorization_identity}

index()

Calls GET /oauth/authorizations

update(oauth_authorization_identity)

Calls POST /oauth/authorizations/#{oauth_authorization_identity}/actions/regenerate-tokens