RCIAM Metrics v0.1.0

Install

Build the Python/Nodejs image

docker-compose build

Pull the database

docker-compose pull

Install python dependencies

docker-compose run --rm --no-deps web pip install --upgrade pip docker-compose run --rm --no-deps web pip3 install --no-cache-dir -r requirements_dev.txt

Install nodejs dependencies

docker-compose run --rm --no-deps api npm install --prefer-online

Run Database deployment

docker-compose run --rm web alembic upgrade head

Seed with test data

Start the Service

docker-compose up api

API Guide

users

read_users_country_registered_users_country_get

Code samples

# You can also use wget
curl -X GET /registered_users_country?tenenv_id=0 \
  -H 'Accept: application/json'

GET /registered_users_country?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/registered_users_country?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/registered_users_country',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/registered_users_country', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/registered_users_country', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/registered_users_country?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/registered_users_country", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /registered_users_country

Read Users Country

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none
startDate	query	string	false	none
endDate	query	string	false	none
tenenv_id	query	integer	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_users_country_groupby_registered_users_country_group_by__group_by__get

Code samples

# You can also use wget
curl -X GET /registered_users_country_group_by/{group_by}?tenenv_id=0 \
  -H 'Accept: application/json'

GET /registered_users_country_group_by/{group_by}?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/registered_users_country_group_by/{group_by}?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/registered_users_country_group_by/{group_by}',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/registered_users_country_group_by/{group_by}', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/registered_users_country_group_by/{group_by}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/registered_users_country_group_by/{group_by}?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/registered_users_country_group_by/{group_by}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /registered_users_country_group_by/{group_by}

Read Users Country Groupby

Parameters

Name	In	Type	Required	Description
group_by	path	string	true	none
offset	query	integer	false	none
startDate	query	string	false	none
endDate	query	string	false	none
tenenv_id	query	integer	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_users_groupby_registered_users_groupby__group_by__get

Code samples

# You can also use wget
curl -X GET /registered_users_groupby/{group_by}?tenenv_id=0 \
  -H 'Accept: application/json'

GET /registered_users_groupby/{group_by}?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/registered_users_groupby/{group_by}?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/registered_users_groupby/{group_by}',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/registered_users_groupby/{group_by}', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/registered_users_groupby/{group_by}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/registered_users_groupby/{group_by}?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/registered_users_groupby/{group_by}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /registered_users_groupby/{group_by}

Read Users Groupby

Parameters

Name	In	Type	Required	Description
group_by	path	string	true	none
offset	query	integer	false	none
interval	query	string	false	none
count_interval	query	integer	false	none
startDate	query	string	false	none
endDate	query	string	false	none
tenenv_id	query	integer	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_users_countby_registered_users_countby_get

Code samples

# You can also use wget
curl -X GET /registered_users_countby?tenenv_id=0 \
  -H 'Accept: application/json'

GET /registered_users_countby?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/registered_users_countby?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/registered_users_countby',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/registered_users_countby', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/registered_users_countby', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/registered_users_countby?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/registered_users_countby", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /registered_users_countby

Read Users Countby

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none
interval	query	string	false	none
count_interval	query	integer	false	none
tenenv_id	query	integer	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

communities

read_members_members__get

Code samples

# You can also use wget
curl -X GET /members/ \
  -H 'Accept: application/json'

GET /members/ HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/members/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/members/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/members/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/members/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/members/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/members/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /members/

Read Members

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none

Example responses

200 Response

[
  {
    "community_id": 0,
    "hasheduserid": "string",
    "status": "string",
    "community_info": {
      "name": "string",
      "description": "string",
      "source": "string",
      "id": 0
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Status Code 200

Response Read Members Members Get

Name	Type	Required	Restrictions	Description
Response Read Members Members Get	[MembersReadWithCommunityInfo]	false	none	none
» MembersReadWithCommunityInfo	MembersReadWithCommunityInfo	false	none	none
»» community_id	integer	true	none	none
»» hasheduserid	string	true	none	none
»» status	string	true	none	none
»» community_info	Community_InfoRead	true	none	none
»»» name	string	true	none	none
»»» description	string	true	none	none
»»» source	string	true	none	none
»»» id	integer	true	none	none

This operation does not require authentication

read_members_bystatus_members_bystatus__get

Code samples

# You can also use wget
curl -X GET /members_bystatus/?tenenv_id=0 \
  -H 'Accept: application/json'

GET /members_bystatus/?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/members_bystatus/?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/members_bystatus/',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/members_bystatus/', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/members_bystatus/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/members_bystatus/?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/members_bystatus/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /members_bystatus/

Read Members Bystatus

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none
community_id	query	integer	false	none
tenenv_id	query	integer	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_communities_communities_groupby__group_by__get

Code samples

# You can also use wget
curl -X GET /communities_groupby/{group_by}?tenenv_id=0 \
  -H 'Accept: application/json'

GET /communities_groupby/{group_by}?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/communities_groupby/{group_by}?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/communities_groupby/{group_by}',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/communities_groupby/{group_by}', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/communities_groupby/{group_by}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/communities_groupby/{group_by}?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/communities_groupby/{group_by}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /communities_groupby/{group_by}

Read Communities

Parameters

Name	In	Type	Required	Description
group_by	path	string	true	none
offset	query	integer	false	none
tenenv_id	query	integer	true	none
interval	query	string	false	none
count_interval	query	integer	false	none
startDate	query	string	false	none
endDate	query	string	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_community_communities__get

Code samples

# You can also use wget
curl -X GET /communities/?tenenv_id=0 \
  -H 'Accept: application/json'

GET /communities/?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/communities/?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/communities/',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/communities/', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/communities/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/communities/?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/communities/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /communities/

Read Community

Parameters

Name	In	Type	Required	Description
community_id	query	integer	false	none
tenenv_id	query	integer	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_communities_info_communities_info__get

Code samples

# You can also use wget
curl -X GET /communities_info/ \
  -H 'Accept: application/json'

GET /communities_info/ HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/communities_info/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/communities_info/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/communities_info/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/communities_info/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/communities_info/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/communities_info/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /communities_info/

Read Communities Info

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none

Example responses

200 Response

[
  {
    "name": "string",
    "description": "string",
    "source": "string",
    "id": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Status Code 200

Response Read Communities Info Communities Info Get

Name	Type	Required	Restrictions	Description
Response Read Communities Info Communities Info Get	[Community_InfoRead]	false	none	none
» Community_InfoRead	Community_InfoRead	false	none	none
»» name	string	true	none	none
»» description	string	true	none	none
»» source	string	true	none	none
»» id	integer	true	none	none

This operation does not require authentication

countries

read_countries_countries__get

Code samples

# You can also use wget
curl -X GET /countries/ \
  -H 'Accept: application/json'

GET /countries/ HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/countries/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/countries/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/countries/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/countries/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/countries/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/countries/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /countries/

Read Countries

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none
tag	query	string	false	none
skip	query	boolean	false	none

Example responses

200 Response

[
  {
    "countrycode": "string",
    "country": "string",
    "id": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Status Code 200

Response Read Countries Countries Get

Name	Type	Required	Restrictions	Description
Response Read Countries Countries Get	[Country_CodesRead]	false	none	none
» Country_CodesRead	Country_CodesRead	false	none	none
»» countrycode	string	true	none	none
»» country	string	true	none	none
»» id	integer	true	none	none

This operation does not require authentication

read_country_stats_country_stats__get

Code samples

# You can also use wget
curl -X GET /country_stats/ \
  -H 'Accept: application/json'

GET /country_stats/ HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/country_stats/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/country_stats/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/country_stats/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/country_stats/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/country_stats/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/country_stats/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /country_stats/

Read Country Stats

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none
tag	query	string	false	none
skip	query	boolean	false	none

Example responses

200 Response

[
  {
    "date": "2019-08-24",
    "hasheduserid": "string",
    "sourceidpid": 0,
    "serviceid": 0,
    "countryid": 0,
    "count": 0,
    "identityprovider_info": {
      "entityid": "string",
      "name": "string",
      "id": 0
    },
    "serviceprovider_info": {
      "identifier": "string",
      "name": "string",
      "id": 0
    },
    "country_info": {
      "countrycode": "string",
      "country": "string",
      "id": 0
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Status Code 200

Response Read Country Stats Country Stats Get

Name	Type	Required	Restrictions	Description
Response Read Country Stats Country Stats Get	[Statistics_Country_HashedwithInfo]	false	none	none
» Statistics_Country_HashedwithInfo	Statistics_Country_HashedwithInfo	false	none	none
»» date	string(date)	true	none	none
»» hasheduserid	string	true	none	none
»» sourceidpid	integer	true	none	none
»» serviceid	integer	true	none	none
»» countryid	integer	true	none	none
»» count	integer	true	none	none
»» identityprovider_info	IdentityprovidersmapRead	false	none	none
»»» entityid	string	true	none	none
»»» name	string	true	none	none
»»» id	integer	true	none	none
»» serviceprovider_info	ServiceprovidersmapRead	false	none	none
»»» identifier	string	true	none	none
»»» name	string	true	none	none
»»» id	integer	true	none	none
»» country_info	Country_CodesRead	false	none	none
»»» countrycode	string	true	none	none
»»» country	string	true	none	none
»»» id	integer	true	none	none

This operation does not require authentication

read_country_stats_by_vo_country_stats_by_vo__community_id__get

Code samples

# You can also use wget
curl -X GET /country_stats_by_vo/{community_id} \
  -H 'Accept: application/json'

GET /country_stats_by_vo/{community_id} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/country_stats_by_vo/{community_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/country_stats_by_vo/{community_id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/country_stats_by_vo/{community_id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/country_stats_by_vo/{community_id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/country_stats_by_vo/{community_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/country_stats_by_vo/{community_id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /country_stats_by_vo/{community_id}

Read Country Stats By Vo

Parameters

Name	In	Type	Required	Description
community_id	path	integer	true	none
offset	query	integer	false	none
tag	query	string	false	none
skip	query	boolean	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

logins

read_logins_per_idp_logins_per_idp_get

Code samples

# You can also use wget
curl -X GET /logins_per_idp?tenenv_id=0 \
  -H 'Accept: application/json'

GET /logins_per_idp?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/logins_per_idp?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/logins_per_idp',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/logins_per_idp', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/logins_per_idp', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/logins_per_idp?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/logins_per_idp", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /logins_per_idp

Read Logins Per Idp

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none
sp	query	string	false	none
startDate	query	string	false	none
endDate	query	string	false	none
tenenv_id	query	integer	true	none
unique_logins	query	boolean	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_logins_per_sp_logins_per_sp_get

Code samples

# You can also use wget
curl -X GET /logins_per_sp?tenenv_id=0 \
  -H 'Accept: application/json'

GET /logins_per_sp?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/logins_per_sp?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/logins_per_sp',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/logins_per_sp', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/logins_per_sp', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/logins_per_sp?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/logins_per_sp", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /logins_per_sp

Read Logins Per Sp

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none
idp	query	string	false	none
startDate	query	string	false	none
endDate	query	string	false	none
tenenv_id	query	integer	true	none
unique_logins	query	boolean	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_logins_per_country_logins_per_country_get

Code samples

# You can also use wget
curl -X GET /logins_per_country?tenenv_id=0 \
  -H 'Accept: application/json'

GET /logins_per_country?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/logins_per_country?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/logins_per_country',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/logins_per_country', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/logins_per_country', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/logins_per_country?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/logins_per_country", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /logins_per_country

Read Logins Per Country

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none
group_by	query	string	false	none
startDate	query	string	false	none
endDate	query	string	false	none
tenenv_id	query	integer	true	none
unique_logins	query	boolean	false	none
idpId	query	integer	false	none
spId	query	integer	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_logins_countby_logins_countby_get

Code samples

# You can also use wget
curl -X GET /logins_countby?tenenv_id=0 \
  -H 'Accept: application/json'

GET /logins_countby?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/logins_countby?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/logins_countby',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/logins_countby', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/logins_countby', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/logins_countby?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/logins_countby", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /logins_countby

Read Logins Countby

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	none
interval	query	string	false	none
count_interval	query	integer	false	none
tenenv_id	query	integer	true	none
unique_logins	query	boolean	false	none
idpId	query	integer	false	none
spId	query	integer	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_logins_groupby_logins_groupby__group_by__get

Code samples

# You can also use wget
curl -X GET /logins_groupby/{group_by}?tenenv_id=0 \
  -H 'Accept: application/json'

GET /logins_groupby/{group_by}?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/logins_groupby/{group_by}?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/logins_groupby/{group_by}',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/logins_groupby/{group_by}', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/logins_groupby/{group_by}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/logins_groupby/{group_by}?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/logins_groupby/{group_by}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /logins_groupby/{group_by}

Read Logins Groupby

Parameters

Name	In	Type	Required	Description
group_by	path	string	true	none
offset	query	integer	false	none
idp	query	string	false	none
sp	query	string	false	none
tenenv_id	query	integer	true	none
unique_logins	query	boolean	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

dashboard

read_tenenv_byname_tenenv__tenant_name___environment_name__get

Code samples

# You can also use wget
curl -X GET /tenenv/{tenant_name}/{environment_name} \
  -H 'Accept: application/json'

GET /tenenv/{tenant_name}/{environment_name} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/tenenv/{tenant_name}/{environment_name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/tenenv/{tenant_name}/{environment_name}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/tenenv/{tenant_name}/{environment_name}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/tenenv/{tenant_name}/{environment_name}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/tenenv/{tenant_name}/{environment_name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/tenenv/{tenant_name}/{environment_name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tenenv/{tenant_name}/{environment_name}

Read Tenenv Byname

Parameters

Name	In	Type	Required	Description
tenant_name	path	string	true	none
environment_name	path	string	true	none
offset	query	integer	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_environment_byname_environment_byname__environment_name__get

Code samples

# You can also use wget
curl -X GET /environment_byname/{environment_name} \
  -H 'Accept: application/json'

GET /environment_byname/{environment_name} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/environment_byname/{environment_name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/environment_byname/{environment_name}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/environment_byname/{environment_name}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/environment_byname/{environment_name}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/environment_byname/{environment_name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/environment_byname/{environment_name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /environment_byname/{environment_name}

Read Environment Byname

Parameters

Name	In	Type	Required	Description
environment_name	path	string	true	none
offset	query	integer	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_idps_idps_get

Code samples

# You can also use wget
curl -X GET /idps?tenenv_id=0 \
  -H 'Accept: application/json'

GET /idps?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/idps?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/idps',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/idps', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/idps', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/idps?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/idps", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /idps

Read Idps

Parameters

Name	In	Type	Required	Description
tenenv_id	query	integer	true	none
idpId	query	integer	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

read_sps_sps_get

Code samples

# You can also use wget
curl -X GET /sps?tenenv_id=0 \
  -H 'Accept: application/json'

GET /sps?tenenv_id=0 HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/sps?tenenv_id=0',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/sps',
  params: {
  'tenenv_id' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/sps', params={
  'tenenv_id': '0'
}, headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/sps', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/sps?tenenv_id=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/sps", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /sps

Read Sps

Parameters

Name	In	Type	Required	Description
tenenv_id	query	integer	true	none
spId	query	integer	false	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

ams

get_verification_ams_stats_ams_verification_hash_get

Code samples

# You can also use wget
curl -X GET /ams_stats/ams_verification_hash \
  -H 'Accept: application/json'

GET /ams_stats/ams_verification_hash HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('/ams_stats/ams_verification_hash',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/ams_stats/ams_verification_hash',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/ams_stats/ams_verification_hash', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/ams_stats/ams_verification_hash', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/ams_stats/ams_verification_hash");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/ams_stats/ams_verification_hash", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /ams_stats/ams_verification_hash

Get Verification

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline

Response Schema

This operation does not require authentication

get_ams_stats_ams_stats_post

Code samples

# You can also use wget
curl -X POST /ams_stats \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string'

POST /ams_stats HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: string

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string'
};

fetch('/ams_stats',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'string'
}

result = RestClient.post '/ams_stats',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'string'
}

r = requests.post('/ams_stats', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'string',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/ams_stats', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/ams_stats");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"string"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/ams_stats", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /ams_stats

Get Ams Stats

Body parameter

null

Parameters

Name	In	Type	Required	Description
Authorization	header	string	false	none
body	body	any	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

This operation does not require authentication

Schemas

Community_InfoRead

{
  "name": "string",
  "description": "string",
  "source": "string",
  "id": 0
}

Community_InfoRead

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
source	string	true	none	none
id	integer	true	none	none

Country_CodesRead

{
  "countrycode": "string",
  "country": "string",
  "id": 0
}

Country_CodesRead

Properties

Name	Type	Required	Restrictions	Description
countrycode	string	true	none	none
country	string	true	none	none
id	integer	true	none	none

HTTPValidationError

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

HTTPValidationError

Properties

Name	Type	Required	Restrictions	Description
detail	[ValidationError]	false	none	none

IdentityprovidersmapRead

{
  "entityid": "string",
  "name": "string",
  "id": 0
}

IdentityprovidersmapRead

Properties

Name	Type	Required	Restrictions	Description
entityid	string	true	none	none
name	string	true	none	none
id	integer	true	none	none

MembersReadWithCommunityInfo

{
  "community_id": 0,
  "hasheduserid": "string",
  "status": "string",
  "community_info": {
    "name": "string",
    "description": "string",
    "source": "string",
    "id": 0
  }
}

MembersReadWithCommunityInfo

Properties

Name	Type	Required	Restrictions	Description
community_id	integer	true	none	none
hasheduserid	string	true	none	none
status	string	true	none	none
community_info	Community_InfoRead	true	none	none

ServiceprovidersmapRead

{
  "identifier": "string",
  "name": "string",
  "id": 0
}

ServiceprovidersmapRead

Properties

Name	Type	Required	Restrictions	Description
identifier	string	true	none	none
name	string	true	none	none
id	integer	true	none	none

Statistics_Country_HashedwithInfo

{
  "date": "2019-08-24",
  "hasheduserid": "string",
  "sourceidpid": 0,
  "serviceid": 0,
  "countryid": 0,
  "count": 0,
  "identityprovider_info": {
    "entityid": "string",
    "name": "string",
    "id": 0
  },
  "serviceprovider_info": {
    "identifier": "string",
    "name": "string",
    "id": 0
  },
  "country_info": {
    "countrycode": "string",
    "country": "string",
    "id": 0
  }
}

Statistics_Country_HashedwithInfo

Properties

Name	Type	Required	Restrictions	Description
date	string(date)	true	none	none
hasheduserid	string	true	none	none
sourceidpid	integer	true	none	none
serviceid	integer	true	none	none
countryid	integer	true	none	none
count	integer	true	none	none
identityprovider_info	IdentityprovidersmapRead	false	none	none
serviceprovider_info	ServiceprovidersmapRead	false	none	none
country_info	Country_CodesRead	false	none	none

ValidationError

{
  "loc": [
    "string"
  ],
  "msg": "string",
  "type": "string"
}

ValidationError

Properties

Name	Type	Required	Restrictions	Description
loc	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

continued

Name	Type	Required	Restrictions	Description
msg	string	true	none	none
type	string	true	none	none

Files

README.md

Latest commit

History

README.md

File metadata and controls

RCIAM Metrics v0.1.0

Install

Build the Python/Nodejs image

Pull the database

Install python dependencies

Install nodejs dependencies

Run Database deployment

Seed with test data

Start the Service

API Guide

users

read_users_country_registered_users_country_get

Parameters

Responses

Response Schema

read_users_country_groupby_registered_users_country_group_by__group_by__get

Parameters

Responses

Response Schema

read_users_groupby_registered_users_groupby__group_by__get

Parameters

Responses

Response Schema

read_users_countby_registered_users_countby_get

Parameters

Responses

Response Schema

communities

read_members_members__get

Parameters

Responses

Response Schema

read_members_bystatus_members_bystatus__get

Parameters

Responses

Response Schema

read_communities_communities_groupby__group_by__get

Parameters

Responses

Response Schema

read_community_communities__get

Parameters

Responses

Response Schema

read_communities_info_communities_info__get

Parameters

Responses

Response Schema

countries

read_countries_countries__get

Parameters

Responses

Response Schema

read_country_stats_country_stats__get

Parameters

Responses

Response Schema

read_country_stats_by_vo_country_stats_by_vo__community_id__get

Parameters

Responses

Response Schema

logins

read_logins_per_idp_logins_per_idp_get

Parameters

Responses

Response Schema

read_logins_per_sp_logins_per_sp_get

Parameters

Responses

Response Schema

read_logins_per_country_logins_per_country_get

Parameters

Responses

Response Schema