/role-store/api/v1/sources/refresh

post https://example.com/role-store/api/v1/sources/refresh

Fetch hosts from local host directory, or users from any user directory.

Responses

Response body

object

uuid

The UUID of the returned object

created

date-time

When the object was created

updated

date-time

When the object was created

updated_by

uuid

ID of the user who updated the object

author

uuid

ID of the user who originally authored the object

enabled

boolean

ttl

integer

How often the source data should be refreshed, time in seconds

status_code

string

Source status, OK / NOK / DISABLED

OK NOK DISABLED

status_text

string

A string indicating source status, free textual format.

name

string

A name describing the source

comment

string

A comment describing the object

tags

username_pattern

array of strings

Array of wildcarded username patters which should be authenticated against this source

username_pattern

external_user_mapping

array of objects

Mapping external users to source users via id+username

external_user_mapping

object

source_id

string

A shared identifier between an external user source and this directory, used to map an external user to this source.

source_search_field

string

Search this field (be that AD/LDAP attribute or a database column) for the user id provided.

session_password_enabled

boolean

child_session_auto_logout_delay

integer

Child session auto logout delay in seconds

session_password_policy

object

Password policy for session password generation

password_min_length

integer

Minimum password length, must be large enough to produce at least WEAK passwords and at least 10

password_max_length

integer

Maximum password length, must be smaller or equal to 99

use_special_characters

boolean

use_lower_case

boolean

use_upper_case

boolean

use_numbers

boolean

password_entropy

integer

Password entropy in bits for session passwords generated from this policy

password_strength

string

VERY_WEAK WEAK STRONG VERY_STRONG

connection

object

Source connection definition - depending on the type, either aws_iam_source, ad source or ldap_source is defined

type

string

Type of the source, LDAP, AD or AWS IAM

LDAP AD GOOGLEGSUITE OIDC AWS GOOGLECLOUD OPENSTACK AZURE LOCAL

address

string

The address of the LDAP/AD/Local source provider

port

integer

The port of the LDAP/AD/Local source provider

service_address_auto_update

boolean

Should the host-service addresses be automatically updated if an address change is detected

iam_access_key_id

string

AWS access key

iam_secret_access_key

string

AWS secret access key

iam_session_token

string

AWS session token

iam_fetch_roles

boolean

Fetch roles from Amazon

iam_fetch_role_path_prefix

string

A prefix for roles to be fetched from Amazon

google_cloud_project_ids

array of strings

Array of Google Cloud project IDs

google_cloud_project_ids

google_cloud_config_json

string

Google Cloud service-account configuration. Base64 encoded JSON blob.

openstack_version

string

The OpenStack version being configured.

V2 V3

openstack_endpoint

string

OpenStack service endpoint url.

openstack_username

string

OpenStack user name for Identity V2 API.

openstack_user_id

string

OpenStack user ID for Identity V3 API, used with Username and DomainID or DomainName

openstack_password

string

OpenStack password for Identity V2 and V3. Either password or API key is used.

openstack_apikey

string

OpenStack API key for Identity V2 and V3. Either password or API key is used.

openstack_domainname

string

OpenStack domain name for Identity V3, used with user name.

openstack_domainid

string

OpenStack domain ID for Identity V3, used with user name.

openstack_token_id

string

OpenStack token ID.

openstack_tenant_ids

array of strings

Array of OpenStack tenant IDs.

openstack_tenant_ids

openstack_tenant_names

array of strings

Array of OpenStack tenant names.

openstack_tenant_names

azure_base_url

string

Azure connection endpoint url

azure_subscription_id

string

Azure subscription ID

azure_tenant_id

string

Azure tenant ID

azure_client_id

string

Azure client ID

azure_client_secret

string

Azure client secret

ldap_protocol

string

LDAP LDAPS STARTTLS

ldap_base

string

The base LDAP/AD DN of the search string

ldap_user_filter

string

The user filter for the base DN

ldap_bind_dn

string

The browse account for LDAP/AD connection

ldap_bind_password

string

The browse account password for LDAP/AD connection

ldap_user_dn_pattern

string

Where to capture the user's distinguished name

google_gsuite_domain

string

google_gsuite_domain_admin_email

string

oidc_enabled

boolean

oidc_issuer

string

oidc_button_title

string

oidc_client_id

string

oidc_client_secret

string

oidc_additional_scopes

array of strings

oidc_additional_scopes

oidc_tags_attribute_name

string

attribute_mapping

object

An object containing remote:local mappings for mapping attributes from remote source to local attribute schema.

Has additional fields

mfa_type

string

Multifactor-authentication-back-end type

DISABLED INTERNAL RADIUS OIDC FIDO MOBILE

mfa_address

string

Multifactor-authentication-back-end address

mfa_port

integer

Multifactor-authentication back-end port

mfa_base_dn

string

Base DN of users who need to authenticate using MFA

domain_controller_fqdn

string

Domain Controller FQDN for Kerberos authentication

domain_controller_port

integer

Domain Controller port number for Kerberos authentication

kerberos_ticket

string

Base64 encoded Kerberos ticket for Kerberos authentication

enable_user_authentication

boolean

Is user authentication enabled for this source

enable_machine_authentication

boolean

Is machine user authentication enabled for this source

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/role-store/api/v1/sources/refresh \
3
     --header 'Authorization: Bearer a-proper-token-goes-here' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/list'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response, refresh started for listed directories.

400Bad request

401Unauthorized request, OAuth2 authorization missing or invalid

403Unauthorized request, OAuth2 authorization OK but scope insufficient

404Resource not found

500Internal server error