Get Iam Settings

Get IAM Global Settings

Retrieves the current IAM Global Settings configuration including API token TTL, access token TTL, and API token retention period. These settings control the lifetime and retention policies for authentication tokens used in the VCF

Request

URI

GET

https://{api_host}/suite-api/api/fleet-management/iam/settings

COPY

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

VCF IAM Global Settings configuration

Returns GlobalIamSettings of type(s) application/json

{
    "accessTokenTtl": 0,
    "allUsersGroupEnabled": false,
    "apiTokenRetentionPeriod": 0,
    "apiTokenTtl": 0,
    "jitInactiveUserEnabled": false,
    "jitInactiveUserTtl": 0
}

integer As int32 As int32

accessTokenTtl

Required

Constraints: minimum: 30 maximum: 480 default: 480

Access Token TTL in minutes

boolean

allUsersGroupEnabled

Required

Enable 'ALL_USERS' group in identity broker

integer As int32 As int32

apiTokenRetentionPeriod

Required

Constraints: minimum: 43200 maximum: 129600 default: 43200

API Token Retention period in minutes

integer As int32 As int32

apiTokenTtl

Required

Constraints: minimum: 43200 maximum: 259200 default: 43200

API Token TTL in minutes

boolean

jitInactiveUserEnabled

Required

Enable JIT Inactive User feature

integer As int32 As int32

jitInactiveUserTtl

Optional

TTL for marking JITed user inactive. Minimum value is 10080 minutes and maximum value is 259200 minutes when jitInactiveUserEnabled is true. When jitInactiveUserEnabled is false the value is set as 0 by default

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/fleet-management/iam/settings

On This Page

Description

Request

Authentication

Response

200 Response Body

Iam Apis Operations