--- title: "Get profile" method: GET path: "/profiles/{id}" tags: ["Profiles"] --- # Get profile `GET /profiles/{id}` ## Request - Base URL: `https://example.itential.io` - URL: `https://example.itential.io/profiles/{id}` - Auth: none declared Returns the profile in the current Itential Platform. ## Path parameters - `id` string, required ## Response `200` Contains the metadata and data of a profile. - ProfilesGetProfileResponse200 - `metadata` ProfilesIdGetResponsesContentApplicationJsonSchemaMetadata - `isActive` boolean: Is profile the active profile. - `activeSync` boolean: Is active profile in sync with the system. - `profile` IapProfilesSchema: The root schema comprises the entire JSON document. - `uiProps` IapProfilesSchemaUiProps - `description` string - `layout` string - `home` string - `login` string - `profile` string - `fav_icon` string - `authenticationProps` IapProfilesSchemaAuthenticationProps - `description` string - `logoutTime` integer: The maximum number of time IAP has to make an api call before the user is logged out, in minutes. - `principalTimeout` integer: The cache time of a given user's principal, in minutes. - `relayStateTimeout` integer: The time before an SSO login callback expires, in seconds. - `uniqueSession` boolean: When uniqueSession is set to true, only one session may be enabled for a given user. - `admins` IapProfilesSchemaAuthenticationPropsAdminsItems[]: Members of these groups will be implicitly assigned with admin permissions - `provenance` string: The name of the AAA adapter in which the groups reside. - `group` string: The name of a user group which will have Pronghorn user management capabilities. - `cookieName` string: The name used by Pronghorn to identify cookies for user session data - `brokerPrincipal` boolean: When brokerPrincipal is set to true, the AAA adapter will be responsible for creating a principal. - `expressProps` IapProfilesSchemaExpressProps - `description` string - `cacheControl` boolean: A boolean flag indicating whether Pronghorn will send the Cache-Control header. This can be useful in environments that leverage caching proxy servers. - `timeout` integer: The maximum number of milliseconds Pronghorn has to respond to a request before a timeout will be returned to the client. - `access_control_allow_origin` string: The configured domain name for the Access-Control-Allow-Origin header used for security. - `express_http` IapProfilesSchemaExpressPropsExpressHttp - `enable` boolean: A boolean flag indicating whether Pronghorn will listen for incoming HTTP requests. - `port` integer - `express_https` IapProfilesSchemaExpressPropsExpressHttps - `enable` boolean: A boolean flag indicating whether Pronghorn will listen for incoming HTTPS requests. - `port` integer - `key` string: The server's private key to use for all https transactions. If the private key is encrypted with a passphrase, you should also include the express_https.passphrase property. - `passphrase` string: The passphrase for the server's private key. You should only include this property if the private key is encrypted with a passphrase. - `cert` string: The server's public certificate to use for all HTTPS transactions. - `secureProtocol` 'TLS_method' | 'TLSv1_2_method' | 'TLSv1_1_method' | 'TLSv1_method': The secureProtocol can be used to configure the set of allowed SSL/TLS protocol versions. Ignored when either tlsMinVersion or tlsMaxVersion is given. - `tlsMinVersion` 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1': Minimum permitted TLS version. Overrides secureProtocol. - `tlsMaxVersion` 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1': Maximum permitted TLS version. Overrides secureProtocol. - `ciphers` string: The set of ciphers to allow when establishing an encrypted session. - `client_reneg_limit` integer: The maximum number of client renegotiations allowed per renegotiation window. - `client_reneg_window` integer: The renegotiation window allows a limited number of client renegotiation requests within a configured number of seconds. - `allowedHttpOptionalVerbs` IapProfilesSchemaExpressPropsAllowedHttpOptionalVerbsItems[]: An array of optional HTTP verbs that are allowed to be used in requests to IAP - `loggerProps` IapProfilesSchemaLoggerProps - `description` string - `log_directory` string: The directory to store Pronghorn log files. - `log_filename` string: The name of the current Pronghorn log file. - `log_max_file_size` integer: The maximum size of each Pronghorn log file in bytes. - `log_max_files` integer: The maximum number of log files maintained on the server. - `log_level` 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'spam' - `console_level` 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'spam' - `log_format_json` boolean: If true, log entries will be written in JSON format. Otherwise, log entries will be written in plaintext. - `console_format_json` boolean: If true, console logs will be written in JSON format. Otherwise, they will be written in plaintext. - `webserver` IapProfilesSchemaLoggerPropsWebserver: Determines how to set up the web server access log. - `log_directory` string: The directory to store web server access log files. - `log_filename` string: The name for the web server access log file. - `syslog` IapProfilesSchemaLoggerPropsSyslog: Allows Pronghorn to send log messages to a local or remote syslog daemon. - `level` 'debug' | 'info' | 'warning' | 'error' - `host` string: The host running syslogd. - `port` integer: The port on the host that syslog is running on. - `protocol` 'tcp4' | 'udp4' | 'unix' | 'unix-connect': The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect. - `facility` string: The syslog facility to use. - `type` 'BSD' | '5424': The type of syslog protocol to use. Possible values are BSD and 5424. - `path` string, uri-reference: The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X). If path is used, host, port and protocol do not need to be configured. - `pid` string: Process identifier (PID) of the process that log messages are coming from (Default is process.pid). - `localhost` string: The host to indicate that log messages are coming from. - `app_name` string: The name of the application. - `eol` string: The end of line character to be added to the end of the message. - `format_json` boolean: If true, syslog logs will be written in JSON format. Otherwise, they will be written in plaintext. - `redisProps` union - IapProfilesSchemaRedisProps0 - `host` string, required: The IP or hostname of the server running the Redis service. - `port` integer, required - IapProfilesSchemaRedisProps1 - `sentinels` IapProfilesSchemaRedisPropsOneOf1SentinelsItems[], required: The list of Redis hosts for sentinel configuration. - `host` string - `port` integer - `name` string, required: The name of the master node in the Redis sentinel group. - `auditProps` IapProfilesSchemaAuditProps - `description` string - `audit` boolean - `brokerValidation` boolean - `pathProps` IapProfilesSchemaPathProps - `description` string - `encrypted` boolean: A boolean flag indicating Pronghorn core is encrypted. - `alarmProps` IapProfilesSchemaAlarmPropsItems[] - `description` string - `ip` string, hostname: The IP address of the remote alarm receiver. FQDNs are also supported in this field. - `community` string: The SNMP community to apply to the outgoing trap or inform. - `properties` IapProfilesSchemaAlarmPropsItems (recursive) - `type` 'trap' | 'inform': The type can be configured as either a trap or inform. - `id` string - `services` string[] - `description` string - `adapterStrategy` IapProfilesSchemaAdapterStrategy - `device` IapProfilesSchemaAdapterStrategyDevice: Defines the order in which southbound systems are called. - `adapterTypes` IapProfilesSchemaAdapterStrategyDeviceAdapterTypesItems[]: A list of adapter types that manages the devices. - `exceptions` IapProfilesSchemaAdapterStrategyDeviceExceptions: An override for the runCommand's preference to a southbound system. - `runCommand` string: Runs a command on a device. - `systemProps` IapProfilesSchemaSystemProps: Properties used to configure IAP process. - `shutdownTimeout` integer: The amount of time a service should wait before shutting down, in seconds. - `servicesBlacklist` string[]: An array of services that blocks CRUD operation access for each service listed. - `launchDelay` integer: The application/adapter launch delay, in seconds. - `launchTimeout` integer: The application/adapter launch timeout, in seconds. - `serviceHealthCheckInterval` integer: How often to update service health, measured in seconds. - `serviceHealthCheckUnhealthyThreshold` integer: Health data staleness threshhold, measured in number of missed health checks. Services which fail to report health data will be assumed to be offline. - `deadProcessCheck` boolean: Enable/disable IAP check for dead applications/adapters. - `deadProcessCheckInterval` integer: How often to check if application/adapter stopped sending healthcheck pings, in seconds. - `deadProcessMaxPeriod` integer: Maximum time period for application/adapter without sending healthcheck ping, in seconds. - `externalRequestTimeout` integer: The timeout for external API requests, in seconds. - `deviceCountPollingInterval` integer: The interval for how often IAP polls for the number of devices, in hours. - `serverIdStrategy` 'mac:port' | 'random': Strategy used to generate server ID, if one is not set using the server_id property. Selecting mac:port will generate a server_id using a combination of MAC address and port, while random will generate a random ID on each startup. - `eventWorkerCount` integer: The number of worker threads available for event processing. - `transformationWorkerCount` integer: The number of worker threads available for transformation processing. - `taskWorkerThreadCount` integer: The number of background threads available for task processing. Maximum value of 4. - `taskWorkerRateLimit` integer: The maximum number of tasks to run per period. The value 0 disables the rate limiter. - `taskWorkerRateLimitPeriod` integer: The time period in seconds for the task worker rate limit. - `prebuiltProps` IapProfilesSchemaPrebuiltProps - `repoConfigs` IapProfilesSchemaPrebuiltPropsRepoConfigs: The configurations used to fetch Prebuilts from different repositories. - `@itentialopensource` IapProfilesSchemaPrebuiltPropsRepoConfigsItentialopensource - `enabled` boolean: A flag that denotes if the repository configuration is connected - `type` 'gitlab': The type of Repository - `hostname` string: The hostname of the Respository endpoint - `path` string: The path of the Repository endpoint - `credentials` IapProfilesSchemaPrebuiltPropsRepoConfigsItentialopensourceCredentials - `token` string: An access token used to make HTTP requests - `integrationProps` IapProfilesSchemaIntegrationProps - `threadCount` integer: The number of threads available for API requests. - `timeout` integer: The number of milliseconds until an integration request times out. - `retryStrategy` IapProfilesSchemaRetryStrategy: Properties used to configure the strategy services use on crash. - `maxRetries` integer: Specifies the amount of times services will retry on crash before stopping. - `retryResetTimer` integer: Specifies the amount of times between each retry before the count will reset in milliseconds. - `serviceDirectory` string: Directory at which to find additional services. ## Other responses - `500`: Error response from API --- [API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)