Account Endpoints

End Point Name: Account Endpoint

API Endpoint: /v1/account

API URL: https://api.iotsec.goskope.com/v1/account

Method: GET

Description: Retrieve the account information.

Authorization: Basic Auth API Authentication

Request Parameters: None

Response Parameters:

id: A unique identifier for the account.
created: The date and time (in ISO format) when the account was created.
updated: The date and time (in ISO format) when the account was last updated.
name: The name assigned to the account.
subdomain: The subdomain used in the vanity URL for this account.
login_url: The unique vanity URL that allows access to the account.
active: A boolean indicating whether the account is currently active.
client_id: A unique client ID assigned to the account, used for API calls.
customer_id: A unique tenant ID for this account.
idp: The identity provider details associated with the account.
license: The type of account license which can be basic or advanced.
sse_tenant_id: A unique identifier for the tenant in the SSE product.
- The default value is -1, which is used when the SSE and DI products are not linked.
- This value is set only when a customer is using both the SSE and DI products, and an association between them has been established.

Response body:

A JSON object with the following structure:

{
    "id": "1234567890",
    "created": "2017-04-01T00:00:00Z",
    "updated": "2017-04-01T00:00:00Z",
    "name": "My IoT Account",
    "subdomain": "sso",
    "login_url": "https://sso.iotsec.goskope.com",
    "active": true,
    "client_id": "abcdefghij",
    "customer_id": "1234567890",
    "tags": [],
    "idp": {
        "client_id": "1234567890",
        "entrypoint_URL": "https://dev-345UYT.oktapreview.com/home/oidc_client/0oadFGHfghVBN/aln5z7CYHGJBNy0g7",
       "issuer_URL": "https://dev-345UYT.oktapreview.com",
        "type": "openid_connect"
    },
    "license": "advanced",
    "sse_tenant_id": -1
}

Example Response:

{
   "id": "5a00b17=36e8957c1a6",
   "created": "2017-04-01T00:00:00Z",
   "updated": "2017-04-01T00:00:00Z",
   "name": "My WootCloud",
   "subdomain": "sso",
   "login_url": "https://sso.abc.def.com",
   "active": true,
   "client_id": "CDFG56oihgMK",
   "customer_id": "5a00b1fghj67ghfa1c1a6",
   "tags": [],
   "idp": {
       "client_id": "0odFVByhNkjhAM0h7",
       "entrypoint_URL": "https://dev-345UYT.oktapreview.com/home/oidc_client/0oadFGHfghVBN/aln5z7CYHGJBNy0g7",
       "issuer_URL": "https://dev-345UYT.oktapreview.com",
       "type": "openid_connect"
   },
   "license": "advanced",
   "sse_tenant_id": -1
}

Account Endpoints

Account Endpoints

Account Endpoints

In this topic ...