Bitium

Languages

Admin - Subscriptions

retrieve the subscriptions within an organization

List all the subscriptions within an organization. Subscriptions give users access to application installations.

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.
q string No Query string (partial name of an application)
email string No Email address of a user in the organization

 

Endpoint Copy

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

Example Request

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

Example Response

[
  {
    "status": "pending", 
    "installation": {
      "status": "pending", 
      "name": "Bugsnag", 
      "created_at": "2015-05-19T13:31:07.206-07:00", 
      "labels": [], 
      "slug": "bugsnag", 
      "provider": {
        "login_method": "spider", 
        "icons": {
          "small": "https://assets-stg.bitium.com/a/images/apps/bugsnag_sm.png", 
          "large": "https://assets-stg.bitium.com/a/images/apps/bugsnag_lg.png", 
          "color_code": "a7d3b0", 
          "first_letter": "b"
        }, 
        "launch_timeout": 45, 
        "capabilities": {
          "has_sync": false, 
          "has_saml": false, 
          "has_provision": false, 
          "has_password_reset": true, 
          "has_import": false, 
          "unsupported_browsers": []
        }, 
        "slug": "bugsnag", 
        "id": 95, 
        "name": "Bugsnag"
      }, 
      "requires_mfa_code": false, 
      "configuration": {
        "extra": null, 
        "url": "https://bugsnag.com", 
        "saml": false, 
        "namespace": [
          "bugsnag.com"
        ], 
        "authentication_type": "browser", 
        "install_type": "individual", 
        "login": null
      }, 
      "id": 33969
    }, 
    "name": "Bugsnag", 
    "created_at": "2015-05-19T13:41:48.776-07:00", 
    "favorite": false, 
    "last_login": null, 
    "launch_url": "https://www.bitium.com/3775/bugsnag", 
    "requires_mfa_code": false, 
    "position": 3, 
    "login": "natalie@bitium.com", 
    "id": 217681
  }, 
  {
    "status": "pending", 
    "installation": {
      "status": "active", 
      "name": "AdSpringr", 
      "created_at": "2015-05-07T14:26:09.222-07:00", 
      "labels": [], 
      "slug": "adspringr", 
      "provider": {
        "login_method": "spider", 
        "icons": {
          "small": "https://assets-stg.bitium.com/a/images/apps/adspringr_sm.png", 
          "large": "https://assets-stg.bitium.com/a/images/apps/adspringr_lg.png", 
          "color_code": "2980b9", 
          "first_letter": "a"
        }, 
        "launch_timeout": 45, 
        "capabilities": {
          "has_sync": false, 
          "has_saml": false, 
          "has_provision": false, 
          "has_password_reset": false, 
          "has_import": false, 
          "unsupported_browsers": []
        }, 
        "slug": "adspringr", 
        "id": 3884, 
        "name": "AdSpringr"
      }, 
      "requires_mfa_code": false, 
      "configuration": {
        "extra": null, 
        "url": "https://api.adspringr.com", 
        "saml": false, 
        "namespace": [
          "api.adspringr.com"
        ], 
        "authentication_type": "browser", 
        "install_type": "shared", 
        "login": “natalie@bitium.com"
      }, 
      "id": 32723
    }, 
    "name": "AdSpringr", 
    "created_at": "2015-05-07T14:26:51.784-07:00", 
    "favorite": false, 
    "last_login": null, 
    "launch_url": "https://www.bitium.com/3775/adspringr", 
    "requires_mfa_code": false, 
    "position": 2, 
    "login": “natalie@bitium.com", 
    "id": 207579
  }]

retrieve a subscription

Required Scopes

  • ORG_READ

 

Endpoint Copy

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

Example Request

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

Example Response

{
	"status": "active",
	"password_strength": {
		"score": 0,
		"crack_time": null,
		"grade": "N/A"
	},
	"installation": {
		"status": "active",
		"name": "Evernote",
		"created_at": "2015-08-17T12:14:18.008-07:00",
		"labels": [],
		"slug": "evernote",
		"provider": {
			"id": 1484,
			"slug": "evernote",
			"name": "Evernote",
			"login_method": "spider",
			"launch_timeout": 45,
			"capabilities": {
				"has_import": false,
				"has_password_reset": true,
				"has_provision": false,
				"has_saml": false,
				"has_sync": false,
				"unsupported_browsers": []
			},
			"icons": {
				"small": "http://assets.bitium.com/a/images/apps/evernote_sm.png",
				"large": "http://assets.bitium.com/a/images/apps/evernote_lg.png",
				"color_code": "65c6bb",
				"first_letter": "e"
			}
		},
		"configuration": {
			"saml": false,
			"login": null,
			"url": "https://www.evernote.com",
			"extra": null,
			"install_type": "individual",
			"authentication_type": "browser",
			"namespace": [
				"www.evernote.com"
			]
		},
		"requires_mfa_code": false,
		"icons": {
			"small": "https://bitium-uploads-dev.s3.amazonaws.com/installation/1/custom_icon/icon_sm.png",
			"large": "https://bitium-uploads-dev.s3.amazonaws.com/installation/1/custom_icon/icon_lg.png"
		}
		"id": 1,
	},
	"name": "Evernote",
	"id": 2,
	"created_at": "2015-08-17T11:05:05.878-07:00",
	"favorite": false,
	"position": 1,
	"login": null,
	"launch_url": "http://bitium.com/1/evernote",
	"requires_mfa_code": false,
	"bookmarks": [],
	"last_login": null,
	
	"permissions": {
	"can_view_password": true,
	"can_reset_password": true
	}
}

fetch subscriptions

Required Scopes

  • ORG_READ

 

Endpoint Copy

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

Example Request

Example Response

create a subscription

Grant a user access to an existing installation within an specified organization.

Required Scopes

  • ORG

Form Parameters

Name Type Required Description
email string Yes Email address for an existing user in the organization
login string Yes Login for the underlying application
password string Yes Password corresponding to the login

 

Endpoint Copy

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

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}/subscriptions \
-X POST \
-d email=1 \ 
-d login=1 \ 
-d password=1

Example Response

{  
   "bookmarks":[  

   ],
   "created_at":"2015-11-18T13:43:35.893-08:00",
   "favorite":false,
   "id":364000,
   "installation":{  
      "configuration":{  
         "authentication_type":"browser",
         "extra":null,
         "install_type":"individual",
         "login":null,
         "namespace":[  
            "instagram.com"
         ],
         "saml":false,
         "url":"https://instagram.com"
      },
      "created_at":"2015-06-26T14:45:30.288-07:00",
      "icons":{  
         "large":"https://bitium-uploads-staging.s3.amazonaws.com/installation/3/7/0/2/1/custom_icon/icon_lg.png",
         "small":"https://bitium-uploads-staging.s3.amazonaws.com/installation/3/7/0/2/1/custom_icon/icon_sm.png"
      },
      "id":37021,
      "key_vault":false,
      "labels":[  

      ],
      "name":"Instagram",
      "provider":{  
         "access_type_cd":null,
         "capabilities":{  
            "has_import":false,
            "has_password_reset":true,
            "has_provision":false,
            "has_saml":false,
            "has_sync":false,
            "unsupported_browsers":[  

            ]
         },
         "icons":{  
            "color_code":"b0bcbf",
            "first_letter":"i",
            "large":"https://assets-stg.bitium.com/a/images/apps/instagram_lg.png",
            "small":"https://assets-stg.bitium.com/a/images/apps/instagram_sm.png"
         },
         "id":218,
         "launch_timeout":45,
         "login_method":"script",
         "name":"Instagram",
         "slug":"instagram"
      },
      "requires_mfa_code":false,
      "slug":"instagram",
      "status":"active"
   },
   "last_login":null,
   "launch_url":"https://www.bitium.com/3775/instagram",
   "login":"bitiumbot",
   "name":"Instagram",
   "password_strength":{  
      "crack_time":0.724,
      "grade":"F",
      "score":0.0
   },
   "permissions":{  
      "can_reset_password":false,
      "can_view_password":false
   },
   "position":6,
   "properties":[  

   ],
   "requires_mfa_code":false,
   "status":"active"
}