Bitium

Languages

Admin - Installations

retrieve the installations within an organization

List the installations within a specified organization.

Required Scopes

  • ORG_READ

Request Parameters

Name Type Required Description
page integer No Page of results to fetch.
Default value: 1
per_page integer No Number of results to return per page.

 

Endpoint Copy

GET https://www.bitium.com/api/v2/organizations/{organization_id}/admin/installations

Example Request

curl -H "Authorization: token {token}" \
-H "X-Device-Id: {unique_id}" \
https://www.bitium.com/api/v2/organizations/{organization_id}/admin/installations?page=1&per_page=1 

Example Response

[
  {
    "status": "active", 
    "name": "Instagram", 
    "icons": {
      "small": "https://bitium-uploads-staging.s3.amazonaws.com/installation/3/7/0/2/1/custom_icon/icon_sm.png", 
      "large": "https://bitium-uploads-staging.s3.amazonaws.com/installation/3/7/0/2/1/custom_icon/icon_lg.png"
    }, 
    "created_at": "2015-06-26T14:45:30.288-07:00", 
    "labels": [], 
    "slug": "instagram", 
    "provider": {
      "login_method": "script", 
      "icons": {
        "small": "https://assets-stg.bitium.com/a/images/apps/instagram_sm.png", 
        "large": "https://assets-stg.bitium.com/a/images/apps/instagram_lg.png", 
        "color_code": "b0bcbf", 
        "first_letter": "i"
      }, 
      "launch_timeout": 45, 
      "capabilities": {
        "has_sync": false, 
        "has_saml": false, 
        "has_provision": false, 
        "has_password_reset": true, 
        "has_import": false, 
        "unsupported_browsers": []
      }, 
      "slug": "instagram", 
      "id": 218, 
      "name": "Instagram"
    }, 
    "requires_mfa_code": false, 
    "configuration": {
      "extra": null, 
      "url": "https://instagram.com", 
      "saml": false, 
      "namespace": [
        "instagram.com"
      ], 
      "authentication_type": "browser", 
      "install_type": "individual", 
      "login": null
    }, 
    "id": 37021
  }, 
  {
    "status": "active", 
    "name": "Amazon Web Services (IAM)", 
    "created_at": "2015-07-15T11:07:24.890-07:00", 
    "labels": [], 
    "slug": "amazon-web-services-iam", 
    "provider": {
      "login_method": "script", 
      "icons": {
        "small": "https://assets-stg.bitium.com/a/images/apps/amazon-iam_sm.png", 
        "large": "https://assets-stg.bitium.com/a/images/apps/amazon-iam_lg.png", 
        "color_code": "65c6bb", 
        "first_letter": "a"
      }, 
      "launch_timeout": 45, 
      "capabilities": {
        "has_sync": false, 
        "has_saml": true, 
        "has_provision": false, 
        "has_password_reset": false, 
        "has_import": false, 
        "unsupported_browsers": []
      }, 
      "slug": "amazon-iam", 
      "id": 148, 
      "name": "Amazon Web Services (IAM)"
    }, 
    "requires_mfa_code": false, 
    "configuration": {
      "extra": "874010680175", 
      "url": "https://console.aws.amazon.com", 
      "saml": false, 
      "namespace": [
        "amazon.com", 
        "aws.amazon.com", 
        "console.aws.amazon.com"
      ], 
      "authentication_type": "browser", 
      "install_type": "individual", 
      "login": null
    }, 
    "id": 38268
  }, 
  {
    "status": "active", 
    "name": "Twitter - Shared", 
    "created_at": "2015-05-07T14:13:44.004-07:00", 
    "labels": [], 
    "slug": "twitter-shared", 
    "provider": {
      "login_method": "spider", 
      "icons": {
        "small": "https://assets-stg.bitium.com/a/images/apps/twitter_sm.png", 
        "large": "https://assets-stg.bitium.com/a/images/apps/twitter_lg.png", 
        "color_code": "7c8d95", 
        "first_letter": "t"
      }, 
      "launch_timeout": 45, 
      "capabilities": {
        "has_sync": false, 
        "has_saml": false, 
        "has_provision": false, 
        "has_password_reset": true, 
        "has_import": false, 
        "unsupported_browsers": []
      }, 
      "slug": "twitter", 
      "id": 44, 
      "name": "Twitter - Shared"
    }, 
    "requires_mfa_code": false, 
    "configuration": {
      "extra": null, 
      "url": "https://twitter.com", 
      "saml": false, 
      "namespace": [
        "twitter.com"
      ], 
      "authentication_type": "browser", 
      "install_type": "shared", 
      "login": "bitiumbot"
    }, 
    "id": 32707
  }
]

create an installation

Required Scopes

  • ORG_READ

Form Parameters

Name Type Required Description
app_id string Yes App ID or slug
base_url string No Site address
subdomain string No Subdomain
domain string No Domain
account string No Account

 

Endpoint Copy

POST https://www.bitium.com/api/v2/organizations/{organization_id}/admin/installations

Example Request

Example Response

retrieve an installation

Required Scopes

  • ORG_READ

 

Endpoint Copy

GET https://www.bitium.com/api/v2/organizations/{organization_id}/admin/installations/{installation_id}

Example Request

curl -H "Authorization: token {token}" \
-H "X-Device-Id: {unique_id}" \
https://www.bitium.com/api/v2/organizations/{organization_id}/admin/installations/{installation_id} 

Example Response

{
  "status": "active", 
  "name": "Pivotal Tracker“, 
  "created_at": "2015-06-29T17:23:43.591-07:00", 
  "labels": [], 
  "slug": null, 
  "subscriptions_count": 0, 
  "average_password_score": {
    "grade": "N/A", 
    "score": null
  }, 
  "provider": {
    "login_method": "spider", 
    "icons": {
      "small": "https://assets-stg.bitium.com/a/images/apps/default_sm.png", 
      "large": "https://assets-stg.bitium.com/a/images/apps/default_lg.png", 
      "color_code": "2980b9", 
      "first_letter": ""
    }, 
    "launch_timeout": 45, 
    "capabilities": {
      "has_sync": null, 
      "has_saml": null, 
      "has_provision": null, 
      "has_password_reset": null, 
      "has_import": null, 
      "unsupported_browsers": []
    }, 
    "slug": null, 
    "id": null, 
    "name": "Pivotaltracker"
  }, 
  "requires_mfa_code": false, 
  "installed_by": {
    "status": "active", 
    "first_name": "Liora", 
    "last_name": "Simozar", 
    "name": "Liora Simozar", 
    "created_at": "2015-05-07T14:05:25.493-07:00", 
    "id": 31213, 
    "last_activity": "2015-08-19T15:45:50.173-07:00", 
    "last_activity_in_seconds": 5664.850536339, 
    "average_password_score": {
      "grade": "F", 
      "score": 0.67
    }, 
    "email": "lns@bitium.com"
  }, 
  "configuration": {
    "extra": "https://www.pivotaltracker.com", 
    "url": "https://www.pivotaltracker.com", 
    "saml": false, 
    "namespace": [
      "www.pivotaltracker.com"
    ], 
    "authentication_type": "browser", 
    "install_type": "individual", 
    "login": null
  }, 
  "id": 37141
}

reset an installation's password

Reset an installation’s password.

 

Endpoint Copy

POST https://www.bitium.com/api/v2/organizations/{organization_id}/admin/installations/{installation_id}/password/reset

Example Request

curl -H "Authorization: token {token}" \
-H "X-Device-Id: {unique_id}" \
https://www.bitium.com/api/v2/organizations/{organization_id}/admin/installations/{installation_id}/password/reset \
-X POST

Example Response