Update Iam Settings

Update Iam Settings
Update IAM Global Settings

Updates the 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
PUT
https://{api_host}/suite-api/api/fleet-management/iam/settings
COPY
Request Body

IAM Settings to be updated

GlobalIamSettings of type(s) application/json
Required

Show optional properties

{
    "accessTokenTtl": 0,
    "allUsersGroupEnabled": false,
    "apiTokenRetentionPeriod": 0,
    "apiTokenTtl": 0,
    "jitInactiveUserEnabled": false
}
{
    "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
Constraints: minimum: 10080 maximum: 259200 default: 43200

TTL for marking JITed user inactive

Authentication
This operation uses the following authentication methods.
Responses
200

IAM Global Settings updated successfully

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
Constraints: minimum: 10080 maximum: 259200 default: 43200

TTL for marking JITed user inactive


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"accessTokenTtl":"integer","allUsersGroupEnabled":"boolean","apiTokenRetentionPeriod":"integer","apiTokenTtl":"integer","jitInactiveUserEnabled":"boolean"}' https://{api_host}/suite-api/api/fleet-management/iam/settings
On This Page
Iam Apis Operations
GET
Get Eligible Components
DELETE
Delete Iam Component Auth Source
POST
Create Iam Component Auth Source
POST
Get Iam Component Auth Sources
GET
Get Component Roles
POST
Provision Component Role
PUT
Update Component Role
GET
Get Component Role Summaries
DELETE
Delete Component Role
GET
Get Component Role
POST
Trigger Drift Check
POST
Retry Apply For Role
GET
Get Component Role Definitions
POST
Configure IDP
PUT
Update IDP Configuration
DELETE
Delete IDP Configuration
GET
Get IDP Configuration
GET
Get Scim Sync Client Info
POST
Generate Scim Sync Client
GET
Get Ldap Directories
POST
Lookup Ldap Groups
POST
Execute Ldap Sync
GET
Get Ldap Sync Logs
GET
Get Ldap Sync Log By Id
GET
Get Ldap Sync Profile
PUT
Update Ldap Sync Profile
POST
Lookup Ldap Users
GET
Get VCF Roles Paginated
POST
Create Role
PUT
Update Role Definition
DELETE
Delete Role
GET
Get Role
POST
Validate Saml Metadata
GET
Get Iam Settings
PUT
Update Iam Settings
GET
Get Sso Realm List
POST
Create Sso Realm
DELETE
Delete Sso Realm
GET
Get Sso Realm
PATCH
Update Api Client
POST
Create Api Client
POST
Query Api Clients
DELETE
Delete Api Client
GET
Get Api Client
PATCH
Update Api Token
POST
Generate Api Token
POST
Query Api Tokens
DELETE
Delete Api Token
GET
Get Api Token
POST
Re Generate Api Token
GET
List Emergency Clients
POST
Create Emergency Client
DELETE
Delete Emergency Client
GET
Get Emergency Client
POST
Regenerate Emergency Client
POST
Get Groups List
POST
Get Group Members List
GET
List O Auth Apps
POST
Create O Auth App
PUT
Update O Auth App
DELETE
Delete O Auth App
GET
Get O Auth App
POST
Rotate O Auth App Secret
DELETE
Delete Role Assignments
GET
Get Role Assignment
PUT
Update Role Assignment
POST
Get Users List
GET
Get Iam Task Details
GET
Get Eligible Vidbs
PATCH
Update Vidb Metadata