Bitium

Languages

User - Apps

retrieve the current contacts's subscriptions

List the application subscriptions for the current contact.

Required Scopes

  • USER_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.
all boolean No Return all subscriptions, ignore pagination

 

Endpoint Copy

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

Example Request

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

Example Response

[
  {
    "status": "pending", 
    "password_strength": {
      "grade": "N/A", 
      "score": 0.0, 
      "crack_time": null
    }, 
    "installation": {
      "status": "active", 
      "name": "LinkedIn", 
      "created_at": "2015-08-13T10:37:10.930-07:00", 
      "labels": [], 
      "slug": "linkedin", 
      "provider": {
        "login_method": "script", 
        "icons": {
          "small": "https://assets-stg.bitium.com/a/images/apps/linkedin_sm.png", 
          "large": "https://assets-stg.bitium.com/a/images/apps/linkedin_lg.png", 
          "color_code": "b0bcbf", 
          "first_letter": "l"
        }, 
        "launch_timeout": 45, 
        "capabilities": {
          "has_sync": false, 
          "has_saml": false, 
          "has_provision": false, 
          "has_password_reset": false, 
          "has_import": false, 
          "unsupported_browsers": []
        }, 
        "slug": "linkedin", 
        "id": 67, 
        "name": "LinkedIn"
      }, 
      "requires_mfa_code": false, 
      "configuration": {
        "extra": null, 
        "url": "https://www.linkedin.com", 
        "saml": false, 
        "namespace": [
          "www.linkedin.com"
        ], 
        "authentication_type": "browser", 
        "install_type": "individual", 
        "login": null
      }, 
      "id": 40668
    }, 
    "name": "LinkedIn", 
    "created_at": "2015-08-13T10:37:11.478-07:00", 
    "favorite": false, 
    "last_login": null, 
    "launch_url": "https://www.bitium.com/3775/linkedin", 
    "requires_mfa_code": false, 
    "position": 9, 
    "login": “lns@bitium.com", 
    "bookmarks": [], 
    "id": 285092, 
    "permissions": {
      "can_view_password": false, 
      "can_reset_password": false
    }
  }, 
   {
    "status": "pending", 
    "password_strength": {
      "grade": "N/A", 
      "score": 0.0, 
      "crack_time": null
    }, 
    "installation": {
      "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
    }, 
    "name": "Instagram", 
    "created_at": "2015-08-14T12:29:01.989-07:00", 
    "favorite": false, 
    "last_login": null, 
    "launch_url": "https://www.bitium.com/3775/instagram", 
    "requires_mfa_code": false, 
    "position": 16, 
    "login": "bitiumbot", 
    "bookmarks": [], 
    "id": 285792, 
    "permissions": {
      "can_view_password": false, 
      "can_reset_password": false
    }
  }]

retrieve a subscription

Required Scopes

  • USER_READ

 

Endpoint Copy

GET https://www.bitium.com/api/v2/organizations/{organization_id}/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}/subscriptions/{subscription_id} 

Example Response

{
  "status": "pending", 
  "password_strength": {
    "grade": "N/A", 
    "score": 0.0, 
    "crack_time": null
  }, 
  "installation": {
    "status": "active", 
    "name": "LinkedIn", 
    "created_at": "2015-08-13T10:37:10.930-07:00", 
    "labels": [], 
    "slug": "linkedin", 
    "provider": {
      "login_method": "script", 
      "icons": {
        "small": "https://assets-stg.bitium.com/a/images/apps/linkedin_sm.png", 
        "large": "https://assets-stg.bitium.com/a/images/apps/linkedin_lg.png", 
        "color_code": "b0bcbf", 
        "first_letter": "l"
      }, 
      "launch_timeout": 45, 
      "capabilities": {
        "has_sync": false, 
        "has_saml": false, 
        "has_provision": false, 
        "has_password_reset": false, 
        "has_import": false, 
        "unsupported_browsers": []
      }, 
      "slug": "linkedin", 
      "id": 67, 
      "name": "LinkedIn"
    }, 
    "requires_mfa_code": false, 
    "configuration": {
      "extra": null, 
      "url": "https://www.linkedin.com", 
      "saml": false, 
      "namespace": [
        "www.linkedin.com"
      ], 
      "authentication_type": "browser", 
      "install_type": "individual", 
      "login": null
    }, 
    "id": 40668
  }, 
  "name": "LinkedIn", 
  "created_at": "2015-08-13T10:37:11.478-07:00", 
  "favorite": false, 
  "subscriber": {
    "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": 5653.645993051, 
    "average_password_score": {
      "grade": "F", 
      "score": 0.67
    }, 
    "email": "llns@bitium.com"
  }, 
  "last_login": null, 
  "launch_url": "https://www.bitium.com/3775/linkedin", 
  "requires_mfa_code": false, 
  "position": 9, 
  "login": “lns@bitium.com", 
  "bookmarks": [], 
  "id": 285092, 
  "permissions": {
    "can_view_password": false, 
    "can_reset_password": false
  }
}

update a subscription

Update the following properties of a specified subscription: name, sort position, or favorite status.

Form Parameters

Name Type Required Description
favorite boolean No Favorite this subscription
name string No Name for this subscription
position integer No Sort position of this subscription

 

Endpoint Copy

PATCH https://www.bitium.com/api/v2/organizations/{organization_id}/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}/subscriptions/{subscription_id} \
-X PATCH \
-d favorite=1 \ 
-d name=1 \ 
-d position=1

Example Response

generate a SAML assertion

Generate the files required to setup a SAML connection.

Form Parameters

Name Type Required Description
RelayState string No

 

Endpoint Copy

POST https://www.bitium.com/api/v2/organizations/{organization_id}/subscriptions/{subscription_id}/assertion

Example Request

curl -H "Authorization: token {token}" \
-H "X-Device-Id: {unique_id}" \
https://www.bitium.com/api/v2/organizations/{organization_id}/subscriptions/{subscription_id}/assertion \
-X POST \
-d RelayState=1

Example Response

retrieve a subscription's credentials

Get a subscription's credential, if authenticated user has access to it.

  • For apps, this will be a login and password
  • For vault items, credential values will be keyed by their properties.

 

Endpoint Copy

POST https://www.bitium.com/api/v2/organizations/{organization_id}/subscriptions/{subscription_id}/credentials

Example Request

Example Response

{
  "login": "me@email.com", 
  "password": "p4ssw0rd123"
}

reset a subscription's password

Reset a specified subscription’s password.

 

Endpoint Copy

POST https://www.bitium.com/api/v2/organizations/{organization_id}/subscriptions/{subscription_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}/subscriptions/{subscription_id}/password/reset \
-X POST

Example Response