Skip to main content

Get IAM configuration

get
/api/pvlt/1.0/ctl/iam/conf

Gets the identity and access management (IAM) configuration in TOML format.

The role that performs this operation must have the CapIAMReader capability. See Access control for more information about how capabilities are used to control access to operations.

Possible responses

The request is successful.

object required*
  • policies - object
    Values of additional properties are objects
    • operations - array of strings
    • policy_type - string required*
    • reasons - array of strings
    • resources - array of strings
  • roles - object
    Values of additional properties are objects
    • capabilities - array of strings
    • policies - array of strings
    • trusted_roles - array of strings
  • users - object
    Values of additional properties are objects
    • disabled - boolean
    • role - string required*
  • idps - object
    Values of additional properties are objects
    • type - string required*
    • disabled - boolean
    • allowed_roles - array of strings
    • roles_map - object
      Values of additional properties are strings
    • conf - object required*
Example
policies = { }
roles = { }
users = { }
idps = { }

Try the API

Authorization

Navigate to the docs of your local Vault installation to try the API directly from there.

Code examples

Example