ex_heroku_client v0.4.0 Heroku.IdentityProvider

Summary

Functions

Calls POST /teams/#{team_identity}/identity-providers

Calls POST /organizations/#{organization_name}/identity-providers

Calls DELETE /teams/#{team_name}/identity-providers/#{identity_provider_id}

Calls DELETE /organizations/#{organization_name}/identity-providers/#{identity_provider_id}

Calls GET /teams/#{team_identity}/identity-providers

Calls GET /organizations/#{organization_name}/identity-providers

Calls PATCH /teams/#{team_identity}/identity-providers/#{identity_provider_id}

Calls PATCH /organizations/#{organization_name}/identity-providers/#{identity_provider_id}

Functions

create_an_identity_provider_for_a_team(team_identity, params)

Calls POST /teams/#{team_identity}/identity-providers

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "certificate": {
      "description": "raw contents of the public certificate (eg: .crt or .pem file)",
      "example": "-----BEGIN CERTIFICATE----- ...",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "entity_id": {
      "description": "URL identifier provided by the identity provider",
      "example": "https://customer-domain.idp.com",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "slo_target_url": {
      "description": "single log out URL for this identity provider",
      "example": "https://example.com/idp/logout",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "sso_target_url": {
      "description": "single sign on URL for this identity provider",
      "example": "https://example.com/idp/login",
      "readOnly": false,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "certificate",
    "sso_target_url",
    "entity_id"
  ],
  "type": [
    "object"
  ]
}
create_an_identity_provider_for_an_organization(organization_name, params)

Calls POST /organizations/#{organization_name}/identity-providers

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "certificate": {
      "description": "raw contents of the public certificate (eg: .crt or .pem file)",
      "example": "-----BEGIN CERTIFICATE----- ...",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "entity_id": {
      "description": "URL identifier provided by the identity provider",
      "example": "https://customer-domain.idp.com",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "slo_target_url": {
      "description": "single log out URL for this identity provider",
      "example": "https://example.com/idp/logout",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "sso_target_url": {
      "description": "single sign on URL for this identity provider",
      "example": "https://example.com/idp/login",
      "readOnly": false,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "certificate",
    "sso_target_url",
    "entity_id"
  ],
  "type": [
    "object"
  ]
}
delete_a_teams_identity_provider(team_name, identity_provider_id)

Calls DELETE /teams/#{team_name}/identity-providers/#{identity_provider_id}

delete_an_organizations_identity_provider(organization_name, identity_provider_id)

Calls DELETE /organizations/#{organization_name}/identity-providers/#{identity_provider_id}

get_a_list_of_a_teams_identity_providers(team_identity)

Calls GET /teams/#{team_identity}/identity-providers

get_a_list_of_an_organizations_identity_providers(organization_name)

Calls GET /organizations/#{organization_name}/identity-providers

update_a_teams_identity_provider(team_identity, identity_provider_id, params \\ %{})

Calls PATCH /teams/#{team_identity}/identity-providers/#{identity_provider_id}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "certificate": {
      "description": "raw contents of the public certificate (eg: .crt or .pem file)",
      "example": "-----BEGIN CERTIFICATE----- ...",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "entity_id": {
      "description": "URL identifier provided by the identity provider",
      "example": "https://customer-domain.idp.com",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "slo_target_url": {
      "description": "single log out URL for this identity provider",
      "example": "https://example.com/idp/logout",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "sso_target_url": {
      "description": "single sign on URL for this identity provider",
      "example": "https://example.com/idp/login",
      "readOnly": false,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}
update_an_organizations_identity_provider(organization_name, identity_provider_id, params \\ %{})

Calls PATCH /organizations/#{organization_name}/identity-providers/#{identity_provider_id}

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "certificate": {
      "description": "raw contents of the public certificate (eg: .crt or .pem file)",
      "example": "-----BEGIN CERTIFICATE----- ...",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "entity_id": {
      "description": "URL identifier provided by the identity provider",
      "example": "https://customer-domain.idp.com",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "slo_target_url": {
      "description": "single log out URL for this identity provider",
      "example": "https://example.com/idp/logout",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "sso_target_url": {
      "description": "single sign on URL for this identity provider",
      "example": "https://example.com/idp/login",
      "readOnly": false,
      "type": [
        "string"
      ]
    }
  },
  "type": [
    "object"
  ]
}