Bonjour ${user.profile.firstName}. Activer le compte
", "isDefault": false, "language": "fr", "subject": "Bienvenue dans ${org.name}!" } }, "CreateUpdateEmailCustomizationResponse": { "value": { "_links": { "preview": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4" }, "template": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" }, "test": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" } }, "body": "Bonjour ${user.profile.firstName}. Activer le compte
", "created": "2021-11-09T20:38:10.000Z", "id": "oel11u6DqUiMbQkpl0g4", "isDefault": false, "language": "fr", "lastUpdated": "2021-11-11T20:38:10.000Z", "subject": "Bienvenue dans ${org.name}!" } }, "CreateUpdateIamRolePermissionRequestExampleWithExclude": { "value": { "conditions": { "exclude": { "okta:ResourceAttribute/User/Profile": [ "zipCode" ] } } } }, "CreateUpdateIamRolePermissionRequestExampleWithInclude": { "value": { "conditions": { "include": { "okta:ResourceAttribute/User/Profile": [ "city", "state" ] } } } }, "CreateUserRequest": { "summary": "Create a user type request", "value": { "description": "A new custom user type", "displayName": "New user type", "name": "newUserType" } }, "CreateUserResponse": { "summary": "Create a user type response", "value": { "_links": { "schema": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" }, "self": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" } }, "created": "2021-07-05T20:40:38.000Z", "createdBy": "sprz9fj1ycBcsgopy1d6", "default": false, "description": "A new custom user type", "displayName": "New user type", "id": "otyfnly5cQjJT9PnR0g4", "lastUpdated": "2021-07-05T20:40:38.000Z", "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", "name": "newUserType" } }, "CsrJsonResponse": { "summary": "CSR object in JSON format", "value": { "_links": { "publish": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50/lifecycle/publish" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50" } }, "created": "2017-03-28T01:11:10.000Z", "csr": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9/tKvvbFN59T4raoCs/78KRm4fSefHQOv1TKLXo4wTLbsqYWRWc5u0sd5orUMQgPQOyj3i6qh13mALY4BzrT057EG1BUNjGg29QgYlnOk2iX890e5BIDMQQEIKFrvOi2V8cLUkLvE2ydRn0VO1Q1frbUkYeStJYC5Api2JQsYRwa+1ZeDH1ITnIzUaugWhW2WB2lSnwZkenne5KtffxMPYVu+IhNRHoKaRA6Z51YNhMJIx17JM2hs/H4Ka3drk6kzDf7ofk/yBpb9yBWyU7CTSQhdoHidxqFprMDaT66W928t3AeOENHBuwn8c2K9WeGG+bELNyQRJVmawIDAQABoCowKAYJKoZIhvcNAQkOMRswGTAXBgNVHREEEDAOggxkZXYub2t0YS5jb20wDQYJKoZIhvcNAQELBQADggEBAA2hsVJRVM+A83X9MekjTnIbt19UNT8wX7wlE9jUKirWsxceLiZBpVGn9qfKhhVIpvdaIRSeoFYS2Kg/m1G6bCvjmZLcrQ5FcEBjZH2NKfNppGVnfC2ugtUkBtCB+UUzOhKhRKJtGugenKbP33zRWWIqnd2waF6Cy8TIuqQVPbwEDN9bCbAs7ND6CFYNguY7KYjWzQOeAR716eqpEEXuPYAS4nx/ty4ylonR8cv+gpq51rvq80A4k/36aoeM0Y6I4w64vhTfuvWW2UYFUD+/+y2FA2CSP4JfctySrf1s525v6fzTFZ3qZbB5OZQtP2b8xYWktMzywsxGKDoVDB4wkH4=", "id": "h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50", "kty": "RSA" } }, "CsrPkcs10Response": { "summary": "CSR in DER format", "value": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9" }, "CustomAAGUIDRequest": { "summary": "Create a custom AAGUID", "value": { "aaguid": "cb69481e-8ff7-4039-93ec-0a272911111", "attestationRootCertificates": [ { "x5c": "X5C..." } ], "authenticatorCharacteristics": { "fipsCompliant": false, "hardwareProtected": false, "platformAttached": false }, "name": "My Security Key" } }, "CustomAAGUIDResponse": { "summary": "Custom AAGUID", "value": { "_links": { "self": { "hints": { "allow": [ "GET", "PUT", "PATCH", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authenticators/aut1nd8PQhGcQtSxB0g4/aaguids/cb69481e-8ff7-4039-93ec-0a272911111" } }, "aaguid": "cb69481e-8ff7-4039-93ec-0a272911111", "attestationRootCertificates": [ { "exp": "2035-05-26T16:04:58.000Z", "iss": "Yubico U2F Root CA Serial 457200631", "x5c": "X5C...", "x5t#S256": "SHA-256 x5t of the X.509 root certificate" } ], "authenticatorCharacteristics": { "fipsCompliant": false, "hardwareProtected": false, "platformAttached": false }, "name": "My Security Key" } }, "CustomAAGUIDUpdateRequest": { "summary": "Update a custom AAGUID", "value": { "attestationRootCertificates": [ { "x5c": "X5C..." } ], "authenticatorCharacteristics": { "fipsCompliant": false, "hardwareProtected": false, "platformAttached": false }, "name": "My Security Key" } }, "CustomAuthSettings": { "summary": "Custom auth settings example", "value": { "appInstanceProperties": [ { "label": "API Key", "name": "apiKey" }, { "label": "API Secret", "name": "apiSecret" } ], "authType": "CUSTOM", "customSettings": null } }, "CustomIDVResponse": { "summary": "Custom IDV as IdP", "value": { "_links": { "users": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa2pstvoFV4GYCw30g5/users" } }, "created": "2025-01-15T20:54:04.000Z", "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa2pstvoFV4GYCw30g5/lifecycle/deactivate" }, "id": "0oa2pstvoFV4GYCw30g5", "lastUpdated": "2025-01-15T20:54:05.000Z", "name": "Custom IDV IdP", "policy": { "maxClockSkew": 0, "provisioning": { "action": "DISABLED", "groups": null, "profileMaster": false }, "subject": { "filter": null, "matchAttribute": null, "matchType": "USERNAME", "userNameTemplate": { "template": "source.userName" } } }, "properties": { "idvMetadata": { "privacyPolicy": "https://idv.example.com/privacy", "termsOfUse": "https://idv.example.com/terms", "vendorDisplayName": "Custom IDV" } }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://idv.example.com/authorize" }, "jwks": { "binding": "HTTP-REDIRECT", "url": "https://idv.example.com/jwks" }, "par": { "binding": "HTTP-REDIRECT", "url": "https://idv.example.com/par" }, "token": { "binding": "HTTP-POST", "url": "https://idv.example.com/token" } }, "issuer": { "url": "https://idv.example.com" }, "scopes": [ "openid", "profile", "identity_assurance" ], "type": "ID_PROOFING" }, "status": "ACTIVE", "type": "IDV_STANDARD" }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "CustomRoleAssignmentRequest": { "value": { "resource-set": "iam4cxy6z7hhaZCSk0g7", "role": "cr04cxy6yzSCtNciD0g7", "type": "CUSTOM" } }, "CustomRoleResponseClient": { "value": { "_links": { "assignee": { "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oa4ee9vgbIuqTUvd0g7" }, "member": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iam4cxy6z7hhaZCSk0g7/bindings/cr04cxy6yzSCtNciD0g7/members/irb4ey26fpFI3vQ8y0g7" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr04cxy6yzSCtNciD0g7/permissions" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iam4cxy6z7hhaZCSk0g7" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr04cxy6yzSCtNciD0g7" } }, "assignmentType": "CLIENT", "created": "2023-05-01T15:16:47.000Z", "id": "irb4ey26fpFI3vQ8y0g7", "label": "view_minimal", "lastUpdated": "2023-05-01T15:16:47.000Z", "resource-set": "iam4cxy6z7hhaZCSk0g7", "role": "cr04cxy6yzSCtNciD0g7", "status": "ACTIVE", "type": "CUSTOM" } }, "CustomRoleResponseUser": { "value": { "_links": { "assignee": { "href\"": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" } }, "assignmentType": "USER", "created": "2019-02-06T16:20:57.000Z", "id": "irb1q92TFAHzySt3x0g4", "label": "UserCreatorRole", "lastUpdated": "2019-02-06T16:20:57.000Z", "resource-set": "iamoJDFKaJxGIr0oamd9g", "role": "cr0Yq6IJxGIr0ouum0g3", "status": "ACTIVE", "type": "CUSTOM" } }, "CustomRolesListResponseClient": { "value": [ { "_links": { "assignee": { "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oa4ee9vgbIuqTUvd0g7" }, "member": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iam4cxy6z7hhaZCSk0g7/bindings/cr04cxy6yzSCtNciD0g7/members/irb4ey26fpFI3vQ8y0g7" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr04cxy6yzSCtNciD0g7/permissions" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iam4cxy6z7hhaZCSk0g7" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr04cxy6yzSCtNciD0g7" } }, "assignmentType": "CLIENT", "created": "2023-05-01T15:16:47.000Z", "id": "irb4ey26fpFI3vQ8y0g7", "label": "view_minimal", "lastUpdated": "2023-05-01T15:16:47.000Z", "resource-set": "iam4cxy6z7hhaZCSk0g7", "role": "cr04cxy6yzSCtNciD0g7", "status": "ACTIVE", "type": "CUSTOM" } ] }, "CustomRolesListResponseGroup": { "value": [ { "_links": { "assignee": { "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK" }, "member": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3/members/irb1qe6PGuMc7Oh8N0g4" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/cr0Yq6IJxGIr0ouum0g3/permissions" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" } }, "assignmentType": "GROUP", "created": "2019-02-06T16:20:57.000Z", "id": "irb1q92TFAHzySt3x0g4", "label": "UserCreatorRole", "lastUpdated": "2019-02-06T16:20:57.000Z", "resource-set": "iamoJDFKaJxGIr0oamd9g", "role": "cr0Yq6IJxGIr0ouum0g3", "status": "ACTIVE", "type": "CUSTOM" } ] }, "CustomTelephonyProviderCredentialCreateRequestTelesignEx": { "summary": "Create a Telesign custom telephony provider", "value": { "providerAuthToken": "67bf6c435967abe806f4f0d6eg2p645", "providerCapability": "ALL", "providerName": "TELESIGN", "providerSettings": { "call": { "telesignService": "telesignVerifyService" }, "sms": { "telesignService": "telesignMessagingService" } }, "providerSid": "CF98EDb19a09b2f5d2f121fe1c207722F7" } }, "CustomTelephonyProviderCredentialCreateRequestTwilioEx": { "summary": "Create a Twilio custom telephony provider", "value": { "providerAuthToken": "11a9b6c435967abe806f4f0d6ec0f382", "providerCapability": "ALL", "providerName": "TWILIO", "providerSettings": { "call": { "twilioVerifySid": "example-verify-sid" }, "sms": { "twilioPhoneNumber": "+1234567890" } }, "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" } }, "CustomTelephonyProviderCredentialCreateResponseTelesignEx": { "summary": "Response for Telesign custom telephony provider", "value": { "enabled": true, "id": "oct1ko8bzvN4smpBU0g5", "isPrimaryProvider": true, "providerCapability": "ALL", "providerName": "TELESIGN", "providerSettings": { "call": { "telesignService": "telesignVoiceService" }, "sms": { "telesignService": "telesignMessagingService" } }, "providerSid": "ACl82fb19a09b2b422f121fe1c2076ch29" } }, "CustomTelephonyProviderCredentialCreateResponseTwilioEx": { "summary": "Response for Twilio custom telephony provider", "value": { "enabled": true, "id": "oct3v00k4iOFlEJmQ806", "isPrimaryProvider": true, "providerCapability": "ALL", "providerName": "TWILIO", "providerSettings": { "call": { "twilioVerifySid": "example-verify-sid" }, "sms": { "twilioPhoneNumber": "+1234567890" } }, "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" } }, "CustomTelephonyProviderCredentialDeactivatedResponseEx": { "summary": "Response for deactivated custom telephony provider", "value": { "enabled": false, "id": "oct3v00k4iOFlEJmQ806", "isPrimaryProvider": false, "providerCapability": "ALL", "providerName": "TWILIO", "providerSettings": { "call": { "twilioVerifySid": "example-verify-sid" }, "sms": { "twilioPhoneNumber": "+1234567890" } }, "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" } }, "CustomTelephonyProviderCredentialListOneResponseEx": { "summary": "Response for credentials of one custom telephony provider", "value": { "enabled": true, "id": "oct3v00k4iOFlEJmQ806", "isPrimaryProvider": true, "providerCapability": "ALL", "providerName": "TWILIO", "providerSettings": { "call": { "twilioVerifySid": "example-verify-sid" }, "sms": { "twilioPhoneNumber": "+1234567890" } }, "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" } }, "CustomTelephonyProviderCredentialPrimaryResponseEx": { "summary": "Response for setting primary custom telephony provider", "value": { "enabled": true, "id": "oct3v00k4iOFlEJmQ806", "isPrimaryProvider": true, "providerCapability": "ALL", "providerName": "TWILIO", "providerSettings": { "call": { "twilioVerifySid": "example-verify-sid" }, "sms": { "twilioPhoneNumber": "+1234567890" } }, "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" } }, "CustomTelephonyProviderCredentialSendTestRequestEx": { "summary": "Send test SMS message", "value": { "countryCodeIso2": "US", "factor": "SMS", "phoneNumber": "+1234567890" } }, "CustomTelephonyProviderCredentialUpdateRequestEx": { "summary": "Update custom telephony provider credentials", "value": { "id": "oct3v00k4iOFlEJmQ806", "providerAuthToken": "11a9b6c435967abe806f4f0d6ec0f382", "providerSettings": { "call": { "twilioVerifySid": "updated-verify-sid" }, "sms": { "twilioPhoneNumber": "+1234567890" } }, "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" } }, "CustomTelephonyProviderCredentialsListAllResponseEx": { "summary": "List of custom telephony provider credentials", "value": [ { "enabled": true, "id": "oct3v00k4iOFlEJmQ806", "isPrimaryProvider": true, "providerCapability": "ALL", "providerName": "TWILIO", "providerSettings": { "call": { "twilioVerifySid": "example-verify-sid" }, "sms": { "twilioPhoneNumber": "+1234567890" } }, "providerSid": "ACb49fb19a09b2f5d2f121fe1c207689dt" }, { "enabled": true, "id": "oct3v00k4iOFlEG3dR45", "isPrimaryProvider": false, "providerCapability": "ALL", "providerName": "TELESIGN", "providerSettings": { "call": { "telesignService": "telesignVerifyService" }, "sms": { "telesignService": "telesignMessagingService" } }, "providerSid": "AC42tfy19a09b2f5d2f121fe1c207fg456r" } ] }, "CustomTelephonyProviderCredentialsUpdateResponseEx": { "summary": "Response for updated custom telephony provider", "value": { "enabled": true, "id": "oct3v00k4iOFlEJmQ806", "isPrimaryProvider": true, "providerCapability": "ALL", "providerName": "TWILIO", "providerSettings": { "call": { "twilioVerifySid": "updated-verify-sid" }, "sms": { "twilioPhoneNumber": "+1234567890" } }, "providerSid": "11a9b6c435967abe806f4f0d6ec0f382" } }, "DbscRefreshResponseExample": { "summary": "Successful DBSC refresh", "value": { "credentials": [ { "attributes": "Domain=example.okta.com; Path=/; Secure; HttpOnly; SameSite=None", "name": "dbsc", "type": "cookie" } ], "refresh_url": "/idp/dbsc/refresh", "scope": { "include_site": false, "origin": "https://example.okta.com" }, "session_identifier": "NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs" } }, "DbscStartResponseExample": { "summary": "Successful DBSC registration", "value": { "credentials": [ { "attributes": "Domain=example.okta.com; Path=/; Secure; HttpOnly; SameSite=None", "name": "dbsc", "type": "cookie" } ], "refresh_url": "/idp/dbsc/refresh", "scope": { "include_site": false, "origin": "https://example.okta.com" }, "session_identifier": "NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs" } }, "DeactivateIdPResponse": { "summary": "Deactivate an IdP", "value": { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62bfdiumsUndnZ0h7&\n client_id={clientId}&response_type={responseType}&response_mode={responseMode}&\n scope={scopes}&redirect_uri={redirectUri}&state={state}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2016-03-24T23:21:49.000Z", "id": "0oa62bfdiumsUndnZ0h7", "lastUpdated": "2016-03-25T19:16:53.000Z", "name": "Google", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": true }, "subject": { "filter": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.userPrincipalName" } }, "trustClaims": false }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://accounts.google.com/o/oauth2/auth" }, "token": { "binding": "HTTP-POST", "url": "https://www.googleapis.com/oauth2/v3/token" } }, "scopes": [ "profile", "email", "openid" ], "type": "OIDC" }, "status": "INACTIVE", "type": "GOOGLE" } }, "DeactivateNetworkZone": { "summary": "Deactivated network zone", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3/lifecycle/activate" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/zones/nzowc1U5Jh5xuAK0o0g3" } }, "created": "2021-06-24T20:37:32.000Z", "gateways": [ { "type": "CIDR", "value": "1.2.3.4/24" } ], "id": "nzowc1U5Jh5xuAK0o0g3", "lastUpdated": "2021-06-24T20:37:32.000Z", "name": "MyIpZone", "proxies": [ { "type": "RANGE", "value": "3.3.4.5-3.3.4.15" } ], "status": "INACTIVE", "system": false, "type": "IP", "usage": "POLICY" } }, "DeactivatedSecurityEventsProviderResponse": { "summary": "Inactive security events provider", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5/lifecycle/activate" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5" } }, "id": "sse1qg25RpusjUP6m0g5", "name": "Security events provider with well-known URL", "settings": { "issuer": "Issuer", "jwks_url": "https://example.okta.com/jwks/path", "well_known_url": "https://example.okta.com/.well-known/ssf-configuration" }, "status": "INACTIVE", "type": "okta" } }, "DefaultAppUserSchemaResponse": { "value": { "$schema": "http://json-schema.org/draft-04/schema#", "created": "2015-02-02T10:27:36.000Z", "definitions": { "base": { "id": "#base", "properties": { "email": { "description": "End-User's preferred email address.", "master": { "type": "PROFILE_MASTER" }, "scope": "SELF", "title": "Email", "type": "string" }, "name": { "description": "End-User's full name in displayable form.", "master": { "type": "PROFILE_MASTER" }, "scope": "SELF", "title": "Name", "type": "string" }, "userName": { "master": { "type": "PROFILE_MASTER" }, "required": true, "scope": "SELF", "title": "Username", "type": "string" } }, "required": [ "userName" ], "type": "object" }, "custom": { "id": "#custom", "properties": {}, "type": "object" }, "properties": { "profile": { "allOf": [ { "$ref": "#/definitions/base" }, { "$ref": "#/definitions/custom" } ] } }, "type": "object" }, "id": "https://{yourOktaDomain}/meta/schemas/apps/{appId}/default", "lastUpdated": "2015-09-05T10:40:45.000Z", "name": "Example app", "title": "Example app User" } }, "DefaultEnhancedDynamicNetworkZone": { "summary": "Default enhanced dynamic network zone", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6" } }, "asns": { "exclude": [], "include": [] }, "created": "2024-05-06T19:12:29.000Z", "id": "nzohcnxFrSgsiwyHp0g4", "ipServiceCategories": { "exclue": [], "include": [ "ALL_ANONYMIZERS" ] }, "lastUpdated": "2024-05-09T21:02:31.000Z", "locations": { "exclude": [], "include": [] }, "name": "DefaultEnhancedDynamicZone", "status": "ACTIVE", "system": true, "type": "DYNAMIC_V2", "usage": "BLOCKLIST" } }, "DefaultIpBlocklistNetworkZone": { "summary": "Default IP blocklist network zone", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0stMCmgOzXK1d6" } }, "created": "2021-06-09T21:32:46.000Z", "gateways": null, "id": "nzou3u0stMCmgOzXK1d6", "lastUpdated": "2021-06-09T21:32:46.000Z", "name": "BlockedIpZone", "proxies": null, "status": "ACTIVE", "system": true, "type": "IP", "usage": "BLOCKLIST" } }, "DefaultIpNetworkZone": { "summary": "Default IP network zone", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0ssJfZjYsWL1d6/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/zones/nzou3u0ssJfZjYsWL1d6" } }, "created": "2021-06-09T21:32:46.000Z", "gateways": null, "id": "nzou3u0ssJfZjYsWL1d6", "lastUpdated": "2021-06-09T21:32:46.000Z", "name": "LegacyIpZone", "proxies": null, "status": "ACTIVE", "system": true, "type": "IP", "usage": "POLICY" } }, "DefaultRealmAssignment": { "value": { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/realm-assignments/rul2jy7jLUlnO5ng00g4", "method": "GET", "rel": "self" } }, "actions": { "assignUserToRealm": { "realmId": "00g1b7rvh0xPLKXFf2g5" } }, "conditions": { "expression": { "value": "string" }, "profileSourceId": "0oa4enoRyjwSCy6hx0g4," }, "created": "2022-04-04T15:56:05.000Z", "id": "rul2jy7jLUlnO5ng00g4", "isDefault": true, "lastUpdated": "2022-05-05T18:15:44.000Z", "name": "Catch-all", "priority": 499, "status": "ACTIVE" } }, "DefaultRealmResponse": { "value": { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/realms/guox9jQ16k9V8IQWL0g3", "method": "GET", "rel": "self" } }, "created": "2022-04-04T15:56:05.000Z", "id": "guox9jQ16k9V8IQWL0g3", "isDefault": true, "lastUpdated": "2022-05-05T18:15:44.000Z", "profile": { "name": "Default realm" } } }, "DeviceAssuranceAndroidRequest": { "summary": "Android request", "value": { "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "jailbreak": false, "name": "Device assurance Android", "osVersion": { "minimum": "12" }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true } }, "DeviceAssuranceAndroidResponse": { "summary": "Android response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "id": "dae3m8o4rWhwReDeM1c5", "jailbreak": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Android", "osVersion": { "minimum": "12.4.5" }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true } }, "DeviceAssuranceAndroidWithAndroidDeviceTrustThirdPartySignalProvidersRequest": { "summary": "Android with Android Device Trust as third-party signal provider request", "value": { "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "jailbreak": false, "name": "Device assurance Android with Android Device Trust third-party signals", "osVersion": { "dynamicVersionRequirement": { "distanceFromLatestMajor": 0, "latestSecurityPatch": true, "type": "EXACT" } }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "androidDeviceTrust": { "deviceIntegrityLevel": "MEETS_STRONG_INTEGRITY", "networkProxyDisabled": true, "playProtectVerdict": "LOW", "requireMajorVersionUpdate": true, "screenLockComplexity": "HIGH", "usbDebuggingDisabled": true, "wifiSecured": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceAndroidWithAndroidDeviceTrustThirdPartySignalProvidersResponse": { "summary": "Android with Android Device Trust as third-party signal provider response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "id": "dae3m8o4rWhwReDeM1c5", "jailbreak": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Android with Android Device Trust third-party signals", "osVersion": { "dynamicVersionRequirement": { "distanceFromLatestMajor": 0, "latestSecurityPatch": true, "type": "EXACT" } }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "androidDeviceTrust": { "deviceIntegrityLevel": "MEETS_STRONG_INTEGRITY", "networkProxyDisabled": true, "playProtectVerdict": "LOW", "requireMajorVersionUpdate": true, "screenLockComplexity": "HIGH", "usbDebuggingDisabled": true, "wifiSecured": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceAndroidWithCallerContextRequest": { "summary": "Android with caller context request", "value": { "callerContext": { "managedApp": true }, "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "jailbreak": false, "name": "Device assurance Android", "osVersion": { "minimum": "12" }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "DeviceAssuranceAndroidWithCallerContextResponse": { "summary": "Android with caller context response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "callerContext": { "managedApp": true }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "id": "dae3m8o4rWhwReDeM1c5", "jailbreak": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Android", "osVersion": { "minimum": "12.4.5" }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "DeviceAssuranceAndroidWithDevicePostureIdPThirdPartySignalProvidersRequest": { "summary": "Android with Device Posture IdP as third-party signal provider request", "value": { "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "jailbreak": false, "name": "Device assurance Android", "osVersion": { "dynamicVersionRequirement": { "distanceFromLatestMajor": 0, "latestSecurityPatch": true, "type": "EXACT" } }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceAndroidWithDevicePostureIdPThirdPartySignalProvidersResponse": { "summary": "Android with Device Posture IdP as third-party signal provider response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "id": "dae3m8o4rWhwReDeM1c5", "jailbreak": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Android", "osVersion": { "dynamicVersionRequirement": { "distanceFromLatestMajor": 0, "latestSecurityPatch": true, "type": "EXACT" } }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceAndroidWithDynamicVersionRequirementRequest": { "summary": "Android with dynamic version requirement request", "value": { "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "jailbreak": false, "name": "Device assurance Android", "osVersion": { "dynamicVersionRequirement": { "distanceFromLatestMajor": 0, "type": "MINIMUM" } }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceAndroidWithDynamicVersionRequirementResponse": { "summary": "Android with dynamic version requirement response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "id": "dae3m8o4rWhwReDeM1c5", "jailbreak": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Android", "osVersion": { "dynamicVersionRequirement": { "distanceFromLatestMajor": 0, "type": "MINIMUM" } }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceAndroidWithGracePeriodRequest": { "summary": "Android with due by date grace period request", "value": { "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "2024-12-01T00:00:00.00Z", "type": "BY_DATE_TIME" }, "jailbreak": false, "name": "Device assurance Android Grace Period", "osVersion": { "dynamicVersionRequirement": { "distanceFromLatestMajor": 0, "type": "MINIMUM" } }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceAndroidWithGracePeriodResponse": { "summary": "Android with due by date grace period response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "USER", "FULL" ] }, "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "2024-12-01T00:00:00.00Z", "type": "BY_DATE_TIME" }, "id": "dae3m8o4rWhwReDeM1c5", "jailbreak": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Android", "osVersion": { "minimum": "12.4.5" }, "platform": "ANDROID", "screenLockType": { "include": [ "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceChromeOSWithDevicePostureIdPThirdPartySignalProvidersRequest": { "summary": "ChromeOS with Device Posture IdP as third-party signal provider request", "value": { "name": "Device assurance ChromeOS", "platform": "CHROMEOS", "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceChromeOSWithDevicePostureIdPThirdPartySignalProvidersResponse": { "summary": "ChromeOS with Device Posture IdP as third-party signal provider response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance ChromeOS", "platform": "CHROMEOS", "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceChromeOSWithDeviceTrustConnectorThirdPartySignalProvidersRequest": { "summary": "ChromeOS with Device Trust Connector as third-party signal provider request", "value": { "name": "Device assurance ChromeOS", "platform": "CHROMEOS", "thirdPartySignalProviders": { "dtc": { "allowScreenLock": true, "browserVersion": { "minimum": "15393.27.0" }, "builtInDnsClientEnabled": true, "chromeRemoteDesktopAppBlocked": true, "deviceEnrollmentDomain": "testDomain", "diskEncrypted": true, "keyTrustLevel": "CHROME_OS_VERIFIED_MODE", "osFirewall": true, "osVersion": { "minimum": "10.0.19041.1110" }, "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", "realtimeUrlCheckMode": true, "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", "screenLockSecured": true, "siteIsolationEnabled": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceChromeOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse": { "summary": "ChromeOS with Device Trust Connector as third-party signal provider response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance ChromeOS", "platform": "CHROMEOS", "thirdPartySignalProviders": { "dtc": { "allowScreenLock": true, "browserVersion": { "minimum": "15393.27.0" }, "builtInDnsClientEnabled": true, "chromeRemoteDesktopAppBlocked": true, "deviceEnrollmentDomain": "testDomain", "diskEncrypted": true, "keyTrustLevel": "CHROME_OS_VERIFIED_MODE", "osFirewall": true, "osVersion": { "minimum": "10.0.19041.1110" }, "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", "realtimeUrlCheckMode": true, "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", "screenLockSecured": true, "siteIsolationEnabled": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceChromeOSWithGracePeriodRequest": { "summary": "ChromeOS with 7 day grace period request", "value": { "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "P7D", "type": "BY_DURATION" }, "name": "Device assurance ChromeOS", "platform": "CHROMEOS", "thirdPartySignalProviders": { "dtc": { "allowScreenLock": true, "browserVersion": { "minimum": "15393.27.0" }, "builtInDnsClientEnabled": true, "chromeRemoteDesktopAppBlocked": true, "deviceEnrollmentDomain": "testDomain", "diskEncrypted": true, "keyTrustLevel": "CHROME_OS_VERIFIED_MODE", "osFirewall": true, "osVersion": { "minimum": "10.0.19041.1110" }, "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", "realtimeUrlCheckMode": true, "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", "screenLockSecured": true, "siteIsolationEnabled": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceChromeOSWithGracePeriodResponse": { "summary": "ChromeOS with due by days grace period response", "value": { "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "P7D", "type": "BY_DURATION" }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance ChromeOS", "platform": "CHROMEOS", "thirdPartySignalProviders": { "dtc": { "allowScreenLock": true, "browserVersion": { "minimum": "15393.27.0" }, "builtInDnsClientEnabled": true, "chromeRemoteDesktopAppBlocked": true, "deviceEnrollmentDomain": "testDomain", "diskEncrypted": true, "keyTrustLevel": "CHROME_OS_VERIFIED_MODE", "osFirewall": true, "osVersion": { "minimum": "10.0.19041.1110" }, "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", "realtimeUrlCheckMode": true, "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", "screenLockSecured": true, "siteIsolationEnabled": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceIosRequest": { "summary": "iOS request", "value": { "jailbreak": false, "name": "Device assurance iOS", "osVersion": { "minimum": "12.4.5" }, "platform": "IOS", "screenLockType": { "include": [ "BIOMETRIC" ] } } }, "DeviceAssuranceIosResponse": { "summary": "iOS response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "id": "dae3m8o4rWhwReDeM1c5", "jailbroken": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance iOS", "osVersion": { "minimum": "12.4.5.9" }, "platform": "IOS", "screenLockType": { "include": [ "BIOMETRIC" ] } } }, "DeviceAssuranceIosWithDevicePostureIdPSignalProvidersRequest": { "summary": "iOS with Device Posture IdP as third-party signal provider request", "value": { "jailbreak": false, "name": "Device assurance iOS", "osVersion": { "minimum": "12.4.5" }, "platform": "IOS", "screenLockType": { "include": [ "BIOMETRIC" ] }, "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceIosWithDevicePostureIdPSignalProvidersResponse": { "summary": "iOS with Device Posture IdP as third-party signal provider response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "id": "dae3m8o4rWhwReDeM1c5", "jailbroken": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance iOS", "osVersion": { "minimum": "12.4.5" }, "platform": "IOS", "screenLockType": { "include": [ "BIOMETRIC" ] }, "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceIosWithDynamicVersionRequirementRequest": { "summary": "iOS with dynamic version requirement request", "value": { "jailbreak": false, "name": "Device assurance iOS", "osVersion": { "dynamicVersionRequirement": { "latestSecurityPatch": true, "type": "EXACT_ANY_SUPPORTED" } }, "platform": "IOS", "screenLockType": { "include": [ "BIOMETRIC" ] } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceIosWithDynamicVersionRequirementResponse": { "summary": "iOS with dynamic version requirement response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "id": "dae3m8o4rWhwReDeM1c5", "jailbroken": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance iOS", "osVersion": { "dynamicVersionRequirement": { "latestSecurityPatch": true, "type": "EXACT_ANY_SUPPORTED" } }, "platform": "IOS", "screenLockType": { "include": [ "BIOMETRIC" ] } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceIosWithGracePeriodRequest": { "summary": "iOS with 30 day grace period request", "value": { "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "P30D", "type": "BY_DURATION" }, "jailbreak": false, "name": "Device assurance iOS Grace Period", "osVersion": { "minimum": "12.4.5" }, "platform": "IOS", "screenLockType": { "include": [ "BIOMETRIC" ] } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceIosWithGracePeriodResponse": { "summary": "iOS with due by days grace period response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "P30D", "type": "BY_DURATION" }, "id": "dae3m8o4rWhwReDeM1c5", "jailbroken": false, "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance iOS", "osVersion": { "minimum": "12.4.5.9" }, "platform": "IOS", "screenLockType": { "include": [ "BIOMETRIC" ] } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceMacOSRequest": { "summary": "macOS request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true } }, "DeviceAssuranceMacOSResponse": { "summary": "macOS response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true } }, "DeviceAssuranceMacOSWithDevicePostureChecksRequest": { "summary": "macOS request with OSQuery device posture check", "value": { "devicePostureChecks": { "include": [ { "value": "1", "variableName": "macOSFirewall" } ] }, "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "DeviceAssuranceMacOSWithDevicePostureChecksResponse": { "summary": "macOS request with OSQuery device posture check", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "devicePostureChecks": { "include": [ { "value": "1", "variableName": "macOSFirewall" } ] }, "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "DeviceAssuranceMacOSWithDevicePostureIdPThirdPartySignalProvidersRequest": { "summary": "macOS with Device Posture IdP as third-party signal provider request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceMacOSWithDevicePostureIdPThirdPartySignalProvidersResponse": { "summary": "macOS with Device Posture IdP as third-party signal provider response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5.9" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceMacOSWithDeviceTrustConnectorThirdPartySignalProvidersRequest": { "summary": "macOS with Device Trust Connector as third-party signal provider request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "dtc": { "browserVersion": { "minimum": "15393.27.0" }, "builtInDnsClientEnabled\"": true, "chromeRemoteDesktopAppBlocked\"": true, "deviceEnrollmentDomain\"": "testDomain", "diskEncrypted": true, "osFirewall": true, "osVersion": { "minimum": "10.0.19041.1110" }, "passwordProtectionWarningTrigger\"": "PASSWORD_PROTECTION_OFF", "realtimeUrlCheckMode\"": true, "safeBrowsingProtectionLevel\"": true, "screenLockSecured": true, "siteIsolationEnabled\"": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceMacOSWithDeviceTrustConnectorThirdPartySignalProvidersResponse": { "summary": "macOS with Device Trust Connector as third-party signal provider response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5.9" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "dtc": { "browserVersion": { "minimum": "15393.27.0" }, "builtInDnsClientEnabled": true, "chromeRemoteDesktopAppBlocked": true, "deviceEnrollmentDomain": "testDomain", "diskEncrypted": true, "keyTrustLevel": "CHROME_BROWSER_HW_KEY", "osFirewall": true, "osVersion": { "minimum": "10.0.19041.1110" }, "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", "realtimeUrlCheckMode": true, "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", "screenLockSecured": true, "siteIsolationEnabled": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceMacOSWithDynamicVersionRequirementRequest": { "summary": "macOS with dynamic version requirement request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance macOS", "osVersion": { "dynamicVersionRequirement": { "distanceFromLatestMajor": 0, "latestSecurityPatch": true, "type": "EXACT" } }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceMacOSWithDynamicVersionRequirementResponse": { "summary": "macOS with dynamic version requirement response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance macOS", "osVersion": { "dynamicVersionRequirement": { "distanceFromLatestMajor": 0, "latestSecurityPatch": true, "type": "EXACT" } }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceMacOSWithGracePeriodRequest": { "summary": "macOS request with due by date grace period request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "2024-12-01T00:00:00.00Z", "type": "BY_DATE_TIME" }, "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceMacOSWithGracePeriodResponse": { "summary": "macOS with due by date grace period response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "2024-12-01T00:00:00.00Z", "type": "BY_DATE_TIME" }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance macOS", "osVersion": { "minimum": "12.4.5" }, "platform": "MACOS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsRequest": { "summary": "Windows request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true } }, "DeviceAssuranceWindowsResponse": { "summary": "Windows response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true } }, "DeviceAssuranceWindowsWithDevicePostureChecksRequest": { "summary": "Windows request with OSQuery device posture check", "value": { "devicePostureChecks": { "include": [ { "value": "1", "variableName": "windowsFirewall" } ] }, "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "DeviceAssuranceWindowsWithDevicePostureChecksResponse": { "summary": "Windows request with OSQuery device posture check", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "devicePostureChecks": { "include": [ { "value": "1", "variableName": "windowsFirewall" } ] }, "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "DeviceAssuranceWindowsWithDevicePostureIdPThirdPartySignalProvidersRequest": { "summary": "Windows with Device Posture IdP as third-party signal provider request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceWindowsWithDevicePostureIdPThirdPartySignalProvidersResponse": { "summary": "Windows with Device Posture IdP as third-party signal provider response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "devicePostureIdP": { "compliant": true, "managed": true } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "DeviceAssuranceWindowsWithDeviceTrustConnectorThirdPartySignalProvidersRequest": { "summary": "Windows with Device Trust Connector as third-party signal provider request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "dtc": { "antivirusEnabled": true, "browserVersion": { "minimum": "15393.27.0" }, "builtInDnsClientEnabled": true, "chromeRemoteDesktopAppBlocked": true, "crowdStrikeAgentId": "testAgentId", "crowdStrikeCustomerId": "testCustomerId", "deviceEnrollmentDomain": "testDomain", "diskEncrypted": true, "keyTrustLevel": "CHROME_BROWSER_HW_KEY", "osFirewall": true, "osVersion": { "minimum": "10.0.19041.1110" }, "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", "realtimeUrlCheckMode": true, "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", "screenLockSecured": true, "secureBootEnabled": true, "siteIsolationEnabled": true, "windowsMachineDomain": "testMachineDomain", "windowsUserDomain": "testUserDomain" } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsWithDeviceTrustConnectorThirdPartySignalProvidersResponse": { "summary": "Windows with Device Trust Connector as third-party signal provider response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true, "thirdPartySignalProviders": { "dtc": { "antivirusEnabled": true, "browserVersion": { "minimum": "15393.27.0" }, "builtInDnsClientEnabled": true, "chromeRemoteDesktopAppBlocked": true, "crowdStrikeAgentId": "testAgentId", "crowdStrikeCustomerId": "testCustomerId", "deviceEnrollmentDomain": "testDomain", "diskEncrypted": true, "keyTrustLevel": "CHROME_BROWSER_HW_KEY", "osFirewall": true, "osVersion": { "minimum": "10.0.19041.1110" }, "passwordProtectionWarningTrigger": "PASSWORD_PROTECTION_OFF", "realtimeUrlCheckMode": true, "safeBrowsingProtectionLevel": "ENHANCED_PROTECTION", "screenLockSecured": true, "secureBootEnabled": true, "siteIsolationEnabled": true, "windowsMachineDomain": "testMachineDomain", "windowsUserDomain": "testUserDomain" } } }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsWithDynamicVersionRequirementsRequest": { "summary": "Windows with Windows 11 and Windows 10 dynamic version requirements request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance Windows", "osVersionConstraints": [ { "dynamicVersionRequirement": { "distanceFromLatestMajor": 1, "latestSecurityPatch": true, "type": "MINIMUM" }, "majorVersionConstraint": "WINDOWS_11" }, { "dynamicVersionRequirement": { "type": "EXACT_ANY_SUPPORTED" }, "majorVersionConstraint": "WINDOWS_10" } ], "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsWithDynamicVersionRequirementsResponse": { "summary": "Windows with Windows 11 and Windows 10 dynamic version requirements response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Windows", "osVersionConstraints": [ { "dynamicVersionRequirement": { "distanceFromLatestMajor": 1, "latestSecurityPatch": true, "type": "MINIMUM" }, "majorVersionConstraint": "WINDOWS_11" }, { "dynamicVersionRequirement": { "type": "EXACT_ANY_SUPPORTED" }, "majorVersionConstraint": "WINDOWS_10" } ], "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsWithGracePeriodRequest": { "summary": "Windows with 7 day grace period request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "P7D", "type": "BY_DURATION" }, "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsWithGracePeriodResponse": { "summary": "Windows with due by days grace period response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "displayRemediationMode": "SHOW", "gracePeriod": { "expiry": "P7D", "type": "BY_DURATION" }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Windows", "osVersion": { "minimum": "12.4.5.9" }, "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionStringRequest": { "summary": "Windows with Windows 11 dynamic version requirement and Windows 10 minimum version request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance Windows", "osVersionConstraints": [ { "dynamicVersionRequirement": { "distanceFromLatestMajor": 1, "type": "EXACT" }, "majorVersionConstraint": "WINDOWS_11" }, { "majorVersionConstraint": "WINDOWS_10", "minimum": "10.0.19045.0" } ], "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsWithWin11DynamicVersionRequirementAndWin10MinimumVersionStringResponse": { "summary": "Windows with Windows 11 dynamic version requirement and Windows 10 minimum version response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Windows", "osVersionConstraints": [ { "dynamicVersionRequirement": { "distanceFromLatestMajor": 1, "type": "EXACT" }, "majorVersionConstraint": "WINDOWS_11" }, { "majorVersionConstraint": "WINDOWS_10", "minimum": "10.0.19045.0" } ], "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirementRequest": { "summary": "Windows with Windows 11 minimum version and a Windows 10 dynamic version requirement request", "value": { "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "name": "Device assurance Windows", "osVersionConstraints": [ { "majorVersionConstraint": "WINDOWS_11", "minimum": "10.0.22000.0" }, { "dynamicVersionRequirement": { "type": "NOT_ALLOWED" }, "majorVersionConstraint": "WINDOWS_10" } ], "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceAssuranceWindowsWithWin11MinimumVersionStringAndWin10DynamicVersionRequirementResponse": { "summary": "Windows with Windows 11 minimum version and Windows 10 dynamic version requirement response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-assurances/dae3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdDate": "2022-01-01T00:00:00.000Z", "diskEncryptionType": { "include": [ "ALL_INTERNAL_VOLUMES" ] }, "id": "dae3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "name": "Device assurance Windows", "osVersionConstraints": [ { "majorVersionConstraint": "WINDOWS_11", "minimum": "10.0.22000.0" }, { "dynamicVersionRequirement": { "type": "NOT_ALLOWED" }, "majorVersionConstraint": "WINDOWS_10" } ], "platform": "WINDOWS", "screenLockType": { "include": [ "PASSCODE", "BIOMETRIC" ] }, "secureHardwarePresent": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "DeviceIntegrationAndroidZeroTrustResponse": { "summary": "Response of device integration for Android Device Trust", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din9lzd33mvS9kjr60g4/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din9lzd33mvS9kjr60g4" } }, "displayName": "Android Device Trust", "id": "din9lzd33mvS9kjr60g4", "name": "com.android.zero.trust", "platform": "ANDROID", "status": "ACTIVE" } }, "DeviceIntegrationChromeDeviceTrustConnectorResponse": { "summary": "Response of a device integration for Chrome Device Trust", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din15gaNrC7BvlBgx0g4/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din15gaNrC7BvlBgx0g4" } }, "displayName": "Chrome Device Trust", "id": "din15gaNrC7BvlBgx0g4", "metadata": { "serviceAccountEmail": "okta-gci-00o158oxTmBNgrgyM0g4@vocal-invention-346218.iam.gserviceaccount.com", "serviceAccountName": "okta-gci-00o158oxTmBNgrgyM0g4", "type": "CHROME" }, "name": "com.google.dtc", "platform": "CHROMEOS", "status": "ACTIVE" } }, "DeviceIntegrationCrowdStrikeResponse": { "summary": "Response of a device integration for CrowdStrike", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dindyfy1f7Pv1eoVF0g4/lifecycle/activate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dindyfy1f7Pv1eoVF0g4" } }, "displayName": "Device Posture Provider", "id": "dindyfy1f7Pv1eoVF0g4", "metadata": { "idpId": "0oa2owlGX5l74kjr60g4", "type": "DEVICE_IDP" }, "name": "com.okta.deviceidp", "platform": "IOS", "status": "DEACTIVATED" } }, "DeviceIntegrationDevicePostureCheckResponse": { "summary": "Response of device integration for Device Posture Check", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din9lzd33mvS9vBwN1c5/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/din9lzd33mvS9vBwN1c5" } }, "displayName": "OSQuery", "id": "din9lzd33mvS9vBwN1c5", "name": "com.okta.device.osquery", "platform": "MACOS", "status": "ACTIVE" } }, "DeviceIntegrationDevicePostureIdPResponse": { "summary": "Response of a device integration for Device Posture Provider", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dindyfzlaerjWVdqt0g4/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dindyfzlaerjWVdqt0g4" } }, "displayName": "Device Posture Provider", "id": "dindyfzlaerjWVdqt0g4", "metadata": { "idpId": "0oa2owlGX5l74kjr60g4", "type": "DEVICE_IDP" }, "name": "com.okta.deviceidp", "platform": "WINDOWS", "status": "ACTIVE" } }, "DeviceIntegrationWindowsSecurityCenterResponse": { "summary": "Response of a device integration for Windows Security Center", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dinjihtR8qWZZF6qe0g4/lifecycle/activate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-integrations/dinjihtR8qWZZF6qe0g4" } }, "displayName": "Windows Security Center", "id": "dinjihtR8qWZZF6qe0g4", "name": "com.okta.windowssecuritycenter", "platform": "WINDOWS", "status": "DEACTIVATED" } }, "DevicePostureChecksMacOSRequest": { "summary": "macOS request", "value": { "description": "Query macOS devices to check if firewall is enabled", "mappingType": "CHECKBOX", "name": "Device posture check macOS", "platform": "MACOS", "query": "SELECT CASE WHEN global_state = 0 THEN 0 ELSE 1 END AS firewall_enabled FROM alf;", "remediationSettings": { "link": { "customUrl": "example.myremediationurl.com/docs", "defaultUrl": null }, "message": { "customText": "It is our company policy that all devices must have a firewall enabled.", "defaultI18nKey": null } }, "type": "CUSTOM", "variableName": "macOSFirewall" } }, "DevicePostureChecksMacOSResponse": { "summary": "macOS response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-posture-checks/dch3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdUpdate": "2022-01-01T00:00:00.000Z", "description": "Query macOS devices to check if firewall is enabled", "id": "dch3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "mappingType": "CHECKBOX", "name": "Device posture check macOS", "platform": "MACOS", "query": "SELECT CASE WHEN global_state = 0 THEN 0 ELSE 1 END AS firewall_enabled FROM alf;", "remediationSettings": { "link": { "customUrl": "example.myremediationurl.com/docs", "defaultUrl": null }, "message": { "customText": "It is our company policy that all devices must have a firewall enabled.", "defaultI18nKey": null } }, "type": "CUSTOM", "variableName": "macOSFirewall" } }, "DevicePostureChecksWindowsRequest": { "summary": "Windows request", "value": { "description": "Query Windows devices to check if firewall is enabled", "mappingType": "CHECKBOX", "name": "Device posture check Windows", "platform": "WINDOWS", "query": "SELECT CASE WHEN enabled = 1 THEN 1 ELSE 0 END AS firewall_enabled FROM windows_firewall_profiles;", "remediationSettings": { "link": { "customUrl": "example.myremediationurl.com/docs", "defaultUrl": null }, "message": { "customText": "It is our company policy that all devices must have a firewall enabled.", "defaultI18nKey": null } }, "type": "CUSTOM", "variableName": "windowsFirewall" } }, "DevicePostureChecksWindowsResponse": { "summary": "Windows response", "value": { "_links": { "self": { "hints": { "allow": [ "DELETE", "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/device-posture-checks/dch3m8o4rWhwReDeM1c5" } }, "createdBy": "00u217pyf72CdUrBt1c5", "createdUpdate": "2022-01-01T00:00:00.000Z", "description": "Query Windows devices to check if firewall is enabled", "id": "dch3m8o4rWhwReDeM1c5", "lastUpdate": "2022-01-01T00:00:00.000Z", "lastUpdatedBy": "00u217pyf72CdUrBt1c5", "mappingType": "CHECKBOX", "name": "Device posture check Windows", "platform": "WINDOWS", "query": "SELECT CASE WHEN enabled = 1 THEN 1 ELSE 0 END AS firewall_enabled FROM windows_firewall_profiles;", "remediationSettings": { "link": { "customUrl": "example.myremediationurl.com/docs", "defaultUrl": null }, "message": { "customText": "It is our company policy that all devices must have a firewall enabled.", "defaultI18nKey": null } }, "type": "CUSTOM", "variableName": "windowsFirewall" } }, "DeviceResponse": { "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET", "PATCH", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4" }, "suspend": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/suspend" }, "users": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/users" } }, "created": "2020-11-03T21:47:01.000Z", "id": "guo8jx5vVoxfvJeLb0w4", "lastUpdated": "2020-11-03T23:46:27.000Z", "profile": { "diskEncryptionType": "NONE", "displayName": "DESKTOP-EHAD3IE", "manufacturer": "International Corp", "model": "VMware7,1", "osVersion": "10.0.18362", "platform": "WINDOWS", "registered": true, "secureHardwarePresent": false, "serialNumber": "56 4d 4f 95 74 c5 d3 e7-fc 3a 57 9c c2 f8 5d ce", "sid": "S-1-5-21-3992267483-1860856704-2413701314-500", "udid": "954F4D56-C574-E7D3-FC3A-579CC2F85DCE" }, "resourceAlternateId": null, "resourceDisplayName": { "sensitive": false, "value": "DESKTOP-EHAD3IE" }, "resourceId": "guo8jx5vVoxfvJeLb0w4", "resourceType": "UDDevice", "status": "ACTIVE" } }, "DeviceWithProvidersResponse": { "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET", "PATCH", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4" }, "suspend": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/lifecycle/suspend" }, "users": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo8jx5vVoxfvJeLb0w4/users" } }, "created": "2020-11-03T21:47:01.000Z", "id": "guo8jx5vVoxfvJeLb0w4", "lastUpdated": "2020-11-03T23:46:27.000Z", "profile": { "diskEncryptionType": "NONE", "displayName": "DESKTOP-EHAD3IE", "manufacturer": "International Corp", "model": "VMware7,1", "osVersion": "10.0.18362", "platform": "WINDOWS", "registered": true, "secureHardwarePresent": false, "serialNumber": "56 4d 4f 95 74 c5 d3 e7-fc 3a 57 9c c2 f8 5d ce", "sid": "S-1-5-21-3992267483-1860856704-2413701314-500", "udid": "954F4D56-C574-E7D3-FC3A-579CC2F85DCE" }, "providers": [ { "payload": { "clientVersion": "7.0" }, "payloadVersion": "1.0", "provider": "oktaVerify" } ], "resourceAlternateId": null, "resourceDisplayName": { "sensitive": false, "value": "DESKTOP-EHAD3IE" }, "resourceId": "guo8jx5vVoxfvJeLb0w4", "resourceType": "UDDevice", "status": "ACTIVE" } }, "EmailCustomizationResponse": { "value": { "_links": { "preview": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4" }, "template": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" }, "test": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" } }, "body": "Hello, ${user.profile.firstName}. Click here to activate your account.", "created": "2021-11-09T20:38:10.000Z", "id": "oel11u6DqUiMbQkpl0g4", "isDefault": true, "language": "en", "lastUpdated": "2021-11-11T20:38:10.000Z", "subject": "Welcome to ${org.name}!" } }, "EmailDomainResponse": { "value": { "displayName": "Admin", "dnsValidationRecords": [ { "fqdn": "_oktaverification.example.com", "recordType": "TXT", "verificationValue": "759080212bda43e3bc825a7d73b4bb64" }, { "fqdn": "mail.example.com", "recordType": "CNAME", "verificationValue": "u22224444.wl024.sendgrid.net" }, { "fqdn": "t02._domainkey.example.com", "recordType": "CNAME", "verificationValue": "t02.domainkey.u22224444.wl024.sendgrid.net" }, { "fqdn": "t022._domainkey.example.com", "recordType": "CNAME", "verificationValue": "t02.domainkey.u22224444.wl024.sendgrid.net" } ], "domain": "example.com", "id": "OeD114iNkrcN6aR680g4", "userName": "admin", "validationStatus": "NOT_STARTED", "validationSubdomain": "mail" } }, "EmailSettingsRequest": { "value": { "recipients": "ALL_USERS" } }, "EmailSettingsResponse": { "value": { "_links": { "self": { "hints": { "allow": [ "GET", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" }, "template": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" } }, "recipients": "ALL_USERS" } }, "EmailTemplateDefaultContentResponse": { "value": { "_links": { "preview": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content/preview" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content" }, "template": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" } }, "body": "
Hello, ${user.profile.firstName}. Click here to activate your account.", "subject": "Welcome to ${org.name}!" } }, "EmbeddedGroupAssignmentSampleResponse": { "summary": "Application group with an embedded group", "value": { "_embedded": { "group": { "_links": { "apps": { "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4/apps" }, "logo": [ { "href": "http://{yourOktaDomain}/assets/img/logos/groups/odyssey/okta-medium.30ce6d4085dff29412984e4c191bc874.png", "name": "medium", "type": "image/png" }, { "href": "http://{yourOktaDomain}/assets/img/logos/groups/odyssey/okta-large.c3cb8cda8ae0add1b4fe928f5844dbe3.png", "name": "large", "type": "image/png" } ], "users": { "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4/users" } }, "created": "2024-06-02T13:02:12.000Z", "id": "00g15acRUy0SYb9GT0g4", "lastMembershipUpdated": "2024-06-02T13:03:13.000Z", "lastUpdated": "2024-06-02T13:02:12.000Z", "objectClass": [ "okta:user_group" ], "profile": { "description": "Group with professional footballers", "name": "Football Group" }, "type": "OKTA_GROUP" } }, "_links": { "app": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" }, "group": { "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" }, "self": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" } }, "id": "00g15acRUy0SYb9GT0g4", "lastUpdated": "2024-06-02T13:17:57.000Z", "priority": 0, "profile": { "department": "marketing", "division": "top", "initialStatus": "active_with_pass", "locale": "en_US", "manager": "Donald Glover", "managerId": "ike.ogb@gmail.com", "organization": "wazobia", "preferredLanguage": "English", "securityAnswer": "Ronaldinho", "securityQuestion": "Who is the footballer to have played the game", "timezone": "Canada/Eastern", "userType": null } } }, "EmbeddedMetadataGroupAssignmentSampleResponse": { "summary": "Application group with embedded metadata", "value": { "_embedded": { "metadata": { "credentials": {}, "profile": { "department": { "lastUpdated": null, "source": { "type": "MAPPING", "value": [ { "id": null } ] } }, "division": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "initialStatus": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "locale": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "manager": { "lastUpdated": null, "source": { "type": "MAPPING", "value": [ { "id": null } ] } }, "managerId": { "lastUpdated": null, "source": { "type": "MAPPING", "value": [ { "id": null } ] } }, "organization": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "preferredLanguage": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "securityAnswer": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "securityQuestion": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "timezone": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "userType": { "lastUpdated": null, "source": { "type": "MAPPING", "value": [ { "id": null } ] } } } } }, "_links": { "app": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" }, "group": { "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" }, "self": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" } }, "id": "00g15acRUy0SYb9GT0g4", "lastUpdated": "2024-06-02T13:17:57.000Z", "priority": 0, "profile": { "department": "marketing", "division": "top", "initialStatus": "active_with_pass", "locale": "en_US", "manager": "Donald Glover", "managerId": "ike.ogb@gmail.com", "organization": "wazobia", "preferredLanguage": "English", "securityAnswer": "Ronaldinho", "securityQuestion": "Who is the footballer to have played the game", "timezone": "Canada/Eastern", "userType": null } } }, "EnrollFactorCallRequest": { "summary": "call", "value": { "factorType": "call", "profile": { "phoneExtension": "1234", "phoneNumber": "+1-555-415-1337" }, "provider": "OKTA" } }, "EnrollFactorCallResponse": { "summary": "call", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clf1nz9JHJGHWRKMTLHP/lifecycle/activate" }, "resend": [ { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clf1nz9JHJGHWRKMTLHP/resend", "name": "call" } ], "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/clf1nz9JHJGHWRKMTLHP" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2014-08-05T20:59:49.000Z", "factorType": "call", "id": "clf1nz9JHJGHWRKMTLHP", "lastUpdated": "2014-08-06T03:59:49.000Z", "profile": { "phoneExtension": "1234", "phoneNumber": "+1-555-415-1337" }, "provider": "OKTA", "status": "PENDING_ACTIVATION", "vendorName": "OKTA" } }, "EnrollFactorCustomTotpRequest": { "summary": "custom totp", "value": { "factorProfileId": "fpr20l2mDyaUGWGCa0g4", "factorType": "token:hotp", "profile": { "sharedSecret": "484f97be3213b117e3a20438e291540a" }, "provider": "CUSTOM" } }, "EnrollFactorCustomTotpResponse": { "summary": "custom totp", "value": { "_links": { "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00utf43LCCmTJVcsK0g3/factors/chf20l33Ks8U2Zjba0g4" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00utf43LCCmTJVcsK0g3" }, "verify": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00utf43LCCmTJVcsK0g3/factors/chf20l33Ks8U2Zjba0g4/verify" } }, "created": "2019-07-22T23:22:36.000Z", "factorType": "token:hotp", "id": "chf20l33Ks8U2Zjba0g4", "lastUpdated": "2019-07-22T23:22:36.000Z", "provider": "CUSTOM", "status": "ACTIVE", "vendorName": "Entrust Datacard" } }, "EnrollFactorEmailRequest": { "summary": "email", "value": { "factorType": "email", "profile": { "email": "test@gmail.com" }, "provider": "OKTA" } }, "EnrollFactorEmailResponse": { "summary": "email", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3/lifecycle/activate" }, "resend": [ { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3/resend", "name": "email" } ], "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3" } }, "factorType": "email", "id": "emfnf3gSScB8xXoXK0g3", "provider": "OKTA", "status": "PENDING_ACTIVATION", "vendorName": "OKTA" } }, "EnrollFactorGoogleRequest": { "summary": "google token:software:totp", "value": { "factorType": "token:software:totp", "provider": "GOOGLE" } }, "EnrollFactorGoogleResponse": { "value": { "_embedded": { "activation": { "_links": { "qrcode": { "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG/qr/00fukNElRS_Tz6k-CFhg3pH4KO2dj2guhmaapXWbc4", "type": "image/png" } }, "encoding": "base32", "keyLength": 16, "sharedSecret": "JBTWGV22G4ZGKV3N", "timeStep": 30 } }, "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG/lifecycle/activate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2014-07-16T16:13:56.000Z", "factorType": "token:software:totp", "id": "ostf1fmaMGJLMNGNLIVG", "lastUpdated": "2014-07-16T16:13:56.000Z", "profile": { "credentialId": "dade.murphy@example.com" }, "provider": "GOOGLE", "status": "PENDING_ACTIVATION", "vendorName": "GOOGLE" } }, "EnrollFactorOVPushRequest": { "summary": "token:software:totp push", "value": { "factorType": "push", "provider": "OKTA" } }, "EnrollFactorOVPushResponse": { "summary": "token:software:totp", "value": { "_embedded": { "activation": { "_links": { "qrcode": { "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4/qr/00Ji8qVBNJD4LmjYy1WZO2VbNqvvPdaCVua-1qjypa", "type": "image/png" }, "send": [ { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4/lifecycle/activate/email", "name": "email" }, { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4/lifecycle/activate/sms", "name": "sms" } ] }, "expiresAt": "2015-11-13T07:44:22.000Z", "factorResult": "WAITING" } }, "_links": { "poll": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4/lifecycle/activate/poll" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/opfbtzzrjgwauUsxO0g4" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2015-11-13T07:34:22.000Z", "factorType": "push", "id": "opfbtzzrjgwauUsxO0g4", "lastUpdated": "2015-11-13T07:34:22.000Z", "provider": "OKTA", "status": "PENDING_ACTIVATION", "vendorName": "OKTA" } }, "EnrollFactorOVTotpRequest": { "summary": "token:software:totp", "value": { "factorType": "token:software:totp", "provider": "OKTA" } }, "EnrollFactorOVTotpResponse": { "summary": "token:software:totp", "value": { "_embedded": { "_links": { "qrcode": { "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG/qr/00fukNElRS_Tz6k-CFhg3pH4KO2dj2guhmaapXWbc4", "type": "image/png" } }, "activation": { "encoding": "base32", "keyLength": 6, "sharedSecret": "JBTWGV22G4ZGKV3N", "timeStep": 30 } }, "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG/lifecycle/activate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf1fmaMGJLMNGNLIVG" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2014-07-16T16:13:56.000Z", "factorType": "token:software:totp", "id": "ostf1fmaMGJLMNGNLIVG", "lastUpdated": "2014-07-16T16:13:56.000Z", "profile": { "credentialId": "dade.murphy@example.com" }, "provider": "OKTA", "status": "PENDING_ACTIVATION", "vendorName": "OKTA" } }, "EnrollFactorQuestionRequest": { "summary": "question", "value": { "question": { "summary": "question factor", "value": { "factorType": "question", "profile": { "answer": "mayonnaise", "question": "disliked_food" }, "provider": "OKTA" } } } }, "EnrollFactorQuestionResponse": { "summary": "question", "value": { "_links": { "questions": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/questions" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ufs1o01OTMGHLAJPVHDZ" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2014-08-05T22:58:49.000Z", "factorType": "question", "id": "ufs1o01OTMGHLAJPVHDZ", "lastUpdated": "2014-08-05T22:58:49.000Z", "profile": { "question": "disliked_food", "questionText": "What is the food you least liked as a child?" }, "provider": "OKTA", "status": "ACTIVE", "vendorName": "OKTA" } }, "EnrollFactorRsaSecurIdRequest": { "summary": "RSA SecurID", "value": { "factorType": "token", "profile": { "credentialId": "dade.murphy@example.com" }, "provider": "RSA", "verify": { "passCode": "5275875498" } } }, "EnrollFactorRsaSecurIdResponse": { "summary": "RSA SecurID", "value": { "_links": { "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/rsabtznMn6cp94ez20g4" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" }, "verify": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/rsabtznMn6cp94ez20g4/verify" } }, "created": "2015-11-13T07:05:53.000Z", "factorType": "token", "id": "rsabtznMn6cp94ez20g4", "lastUpdated": "2015-11-13T07:05:53.000Z", "profile": { "credentialId": "dade.murphy@example.com" }, "provider": "RSA", "status": "ACTIVE", "vendorName": "RSA" } }, "EnrollFactorSmsRequest": { "summary": "sms", "value": { "factorType": "sms", "profile": { "phoneNumber": "+1-555-415-1337" }, "provider": "OKTA" } }, "EnrollFactorSmsResponse": { "summary": "sms", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/mbl1nz9JHJGHWRKMTLHP/lifecycle/activate" }, "resend": [ { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/mbl1nz9JHJGHWRKMTLHP/resend", "name": "sms" } ], "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/mbl1nz9JHJGHWRKMTLHP" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2014-08-05T20:59:49.000Z", "factorType": "sms", "id": "mbl1nz9JHJGHWRKMTLHP", "lastUpdated": "2014-08-06T03:59:49.000Z", "profile": { "phoneNumber": "+1-555-415-1337" }, "provider": "OKTA", "status": "PENDING_ACTIVATION", "vendorName": "OKTA" } }, "EnrollFactorSymantecVipRequest": { "summary": "Symantec VIP", "value": { "factorType": "token", "profile": { "credentialId": "VSMT14393584" }, "provider": "SYMANTEC", "verify": { "nextPassCode": "678195", "passCode": "875498" } } }, "EnrollFactorSymantecVipResponse": { "summary": "Symantec VIP", "value": { "_links": { "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ufvbtzgkYaA7zTKdQ0g4" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" }, "verify": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ufvbtzgkYaA7zTKdQ0g4/verify" } }, "created": "2015-11-13T06:52:08.000Z", "factorType": "token", "id": "ufvbtzgkYaA7zTKdQ0g4", "lastUpdated": "2015-11-13T06:52:08.000Z", "profile": { "credentialId": "VSMT14393584" }, "provider": "SYMANTEC", "status": "ACTIVE", "vendorName": "SYMANTEC" } }, "EnrollFactorU2fRequest": { "summary": "u2f", "value": { "factorType": "u2f", "provider": "FIDO" } }, "EnrollFactorU2fResponse": { "summary": "u2f", "value": { "_embedded": { "activation": { "nonce": "9DmGJDLvaU6KWxJbfrZ0", "timeoutSeconds": 20, "version": "U2F_V2" } }, "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fuf2rovRxogXJ0nDy0g4/lifecycle/activate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fuf2rovRxogXJ0nDy0g4" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2018-05-24T20:43:19.000Z", "factorType": "u2f", "id": "fuf2rovRxogXJ0nDy0g4", "lastUpdated": "2018-05-24T20:43:19.000Z", "provider": "FIDO", "status": "PENDING_ACTIVATION", "vendorName": "FIDO" } }, "EnrollFactorWebauthnRequest": { "summary": "webAuthn", "value": { "factorType": "webauthn", "provider": "FIDO" } }, "EnrollFactorWebauthnResponse": { "summary": "webAuthn", "value": { "_embedded": { "activation": { "attestation": "direct", "authenticatorSelection": { "requireResidentKey": false, "userVerification": "preferred" }, "challenge": "cdsZ1V10E0BGE4GcG3IK", "excludeCredentials": [], "pubKeyCredParams": [ { "alg": -7, "type": "public-key" }, { "alg": -257, "type": "public-key" } ], "rp": { "name": "Rain-Cloud59" }, "user": { "displayName": "First Last", "id": "00u15s1KDETTQMQYABRL", "name": "first.last@gmail.com" } } }, "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fwf2rovRxogXJ0nDy0g4/lifecycle/activate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/fwf2rovRxogXJ0nDy0g4" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2018-05-24T20:43:19.000Z", "factorType": "webauthn", "id": "fwf2rovRxogXJ0nDy0g4", "lastUpdated": "2018-05-24T20:43:19.000Z", "provider": "FIDO", "status": "PENDING_ACTIVATION", "vendorName": "FIDO" } }, "EnrollFactorYubikeyRequest": { "summary": "yubikey", "value": { "factorType": "token:hardware", "provider": "YUBICO", "verify": { "passCode": "cccccceukngdfgkukfctkcvfidnetljjiknckkcjulji" } } }, "EnrollFactorYubikeyResponse": { "value": { "_links": { "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "hhttps://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ykfbty3BJeBgUi3750g4" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" }, "verify": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ykfbty3BJeBgUi3750g4/verify" } }, "created": "2015-11-13T05:27:49.000Z", "factorType": "token:hardware", "id": "ykfbty3BJeBgUi3750g4", "lastUpdated": "2015-11-13T05:27:49.000Z", "profile": { "credentialId": "000004102994" }, "provider": "YUBICO", "status": "ACTIVE", "vendorName": "YUBICO" } }, "EnrollmentActivationRequestExample": { "summary": "Enrollment activation request", "value": { "credResponses": [ { "authenticatorEnrollmentId": "fwf5ajzJEWqknX6lk0g4", "credResponseJwe": "eyJlcGsiOnsia3R5IjoiRUM..." } ], "fulfillmentProvider": "yubico", "pinResponseJwe": "eyJl5IjoiRUMiLCJjcnYcGsiOnsia3...", "serial": "3632071", "userId": "00us2hPODQncCkxef0g3", "version": "5.4.3", "yubicoSigningJwks": [ { "crv": "P-384", "kid": "APCS-Tsgnkey-C19881-H0027616953", "kty": "EC", "use": "sig", "x": "tJc-j5osUCP-75ihCOKsswTOj3XsekayG3x79K2ndyOIXu08gDMkvL8rks06tEAa", "y": "hfVGbQeG4l2orqenn-GATWwTm8tLqHFHuwfJp33CCNOMtYYsgkAEnW60ORzt4YV-" } ] } }, "EnrollmentActivationResponseExample": { "summary": "Enrollment activation response", "value": { "authenticatorEnrollmentIds": [ "fwf5ajzJEWqknX6lk0g4" ], "fulfillmentProvider": "yubico", "userId": "00us2hPODQncCkxef0g3" } }, "EnrollmentInitializationRequestExample": { "summary": "Initialize preregistration enrollment request", "value": { "enrollmentRpIds": [ "myorg.okta.com" ], "fulfillmentProvider": "yubico", "userId": "00us2hPODQncCkxef0g3", "yubicoTransportKeyJWK": { "crv": "P-384", "kid": "APCS-Ttrans-C19881-I009", "kty": "EC", "use": "enc", "x": "r6AzcX3OSiJk1yQaBVYiBOtzFS9gNSpMDPvnVvl0CAX7el1ZyzmPG_BZ7u8sqTmF", "y": "RxPyGH1Xg74E2f5AQGkkddzsvTNY1R3R7mXTEM5wQtr1Y7C4XHlvITNZfU6G" } } }, "EnrollmentInitializationResponseExample": { "summary": "Initialize preregistration enrollment request", "value": { "credRequests": [ { "authenticatorEnrollmentId": "fwf5ajzJEWqknX6lk0g4", "credRequestJwe": "eyJlcGsiOnsia3R5IjoiRUMiLCJ...", "keyId": "h2r91gconqiai1vs0psg" } ], "fulfillmentProvider": "yubico", "pinRequestJwe": "eyJlcGsa3R5IjoiRUMiLA...", "userId": "00us2hPODQncCkxef0g3" } }, "EntitlementValuesResponse": { "summary": "List of bundle entitlement values", "value": { "_links": { "bundle": { "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA" }, "entitlements": { "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA/entitlements" }, "self": { "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles?limit=2&after=10" } }, "entitlementValues": [ { "_links": { "group": "http://your-subdomain.okta.com/api/v1/groups/00guaxWZ0AOa5NFAj0g3" }, "id": "entfxqCAJWWGELFTYAAA", "name": "Restricted users group", "value": "orn:okta:00o5rb5mt2H3d1TJd0h7:groups:00guaxWZ0AOa5NFAj0g3" } ] } }, "ErrorAccessDenied": { "summary": "Access Denied", "value": { "errorCauses": [], "errorCode": "E0000006", "errorId": "sampleNUSD_8fdkFd8fs8SDBK", "errorLink": "E0000006", "errorSummary": "You do not have permission to perform the requested action" } }, "ErrorAgentTimeOut": { "value": { "errorCauses": [], "errorCode": "E0000237", "errorId": "sampleMlLvGUj_YD5v16vkYWY", "errorLink": "E0000237", "errorSummary": "Timed out waiting for agent" } }, "ErrorAlreadyRegistered": { "summary": "DBSC already registered", "value": { "errorCauses": [], "errorCode": "E0000195", "errorId": "oae123abc", "errorLink": "E0000195", "errorSummary": "DBSC binding already exists for this session" } }, "ErrorApiValidationConflict": { "summary": "Conflict", "value": { "errorCauses": [], "errorCode": "E0000195", "errorId": "sampleMlLvGUj_YD5v15vkYWX", "errorLink": "E0000195", "errorSummary": "Api validation failed due to conflict: {0}" } }, "ErrorApiValidationFailed": { "summary": "API Validation Failed", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: {0}" } }, "ErrorAppFeatureAPIValidationFailed": { "summary": "API validation failed", "value": { "errorCauses": [ { "errorSummary": "Provisioning is not enabled for the app instance." } ], "errorCode": "E0000001", "errorId": "oaeZLxeiHUUQomPkM8xOqvu1A", "errorLink": "E0000001", "errorSummary": "Api validation failed: feature" } }, "ErrorAppUserForbiddenAction": { "description": "If the `PUSH_NEW_USERS` or `PUSH_PROFILE_UPDATES` feature is enabled and the request specifies a value for a profile-mapped (Universal Directory) attribute that doesn't match the mapped value, then a 403 error is returned.", "summary": "Forbidden action", "value": { "errorCauses": [], "errorCode": "E0000075", "errorId": "sampleWXiR_K-WwaTKhlgBQ", "errorLink": "E0000075", "errorSummary": "Cannot modify the firstName attribute because it has a field mapping and profile push is enabled." } }, "ErrorAppUserUpdateBadRequest": { "description": "If you attempt to assign a username or password to an app with an incompatible authentication scheme, then a 400 error is returned.", "summary": "Bad request", "value": { "errorCauses": { "errorSummary": "User level credentials should not be provided for this scheme." }, "errorCode": "E0000041", "errorId": "oaeUM77NBynQQu4C_qT5ngjGQ", "errorLink": "E0000041", "errorSummary": "Credentials should not be set on this resource based on the scheme." } }, "ErrorBotProtectionEnforcementTypeRequired": { "summary": "Enforcement type is required when mode is ENFORCED", "value": { "errorCauses": [ { "errorSummary": "enforcementType: Api validation failed: enforcementType must be provided when mode is ENFORCED" } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: enforcementType" } }, "ErrorBotProtectionLevelRequired": { "summary": "Level is required", "value": { "errorCauses": [ { "errorSummary": "level: The field cannot be left blank" } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: level" } }, "ErrorBotProtectionModeRequired": { "summary": "Mode is required", "value": { "errorCauses": [ { "errorSummary": "mode: The field cannot be left blank" } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: mode" } }, "ErrorBotProtectionSupportedFlowsRequired": { "summary": "Supported flows must have at least one flow", "value": { "errorCauses": [ { "errorSummary": "supportedFlows: Api validation failed: supportedFlows must have at least one supported flow" } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: supportedFlows" } }, "ErrorCAPTCHALimitOfOne": { "value": { "errorCauses": [], "errorCode": "E0000165", "errorId": "oaejrB1fWL1S7mc-2KcG-SOtw", "errorLink": "E0000165", "errorSummary": "CAPTCHA count limit reached. At most one CAPTCHA instance is allowed per Org." } }, "ErrorCAPTCHAOrgWideSetting": { "value": { "errorCauses": [], "errorCode": "E0000149", "errorId": "samplezsusshPdiTWiITwqBt8", "errorLink": "E0000149", "errorSummary": "Current CAPTCHA is associated with org-wide settings, cannot be removed." } }, "ErrorCAPTCHAOrgWideSettingNull": { "summary": "captchaId is null, but enabledPages is defined", "value": { "errorCauses": { "errorSummary": "captchaId: Invalid CAPTCHA ID. The value of captchaId cannot be blank when enabledPages is not empty. Please resubmit with an existing CAPTCHA ID or disable CAPTCHA support on all supported pages." }, "errorCode": "E0000001", "errorId": "oae-hk3rssXQmOWDRsaFfxe8A", "errorLink": "E0000001", "errorSummary": "Api validation failed: captchaId" } }, "ErrorChallengeExpired": { "summary": "Refresh challenge not found or expired", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "DBSC challenge expired or not found" } }, "ErrorChallengeMismatch": { "summary": "Challenge validation failed", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "DBSC challenge validation failed" } }, "ErrorChallengeNotFound": { "summary": "Registration challenge not found or expired", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "Registration challenge not found or expired" } }, "ErrorChallengeRequired": { "summary": "Challenge required for refresh", "value": { "errorCauses": [], "errorCode": "E0000031", "errorId": "oae123abc", "errorLink": "E0000031", "errorSummary": "DBSC cookie required" } }, "ErrorClientJsonWebKeyDuplicateKid": { "value": { "errorCauses": [ { "errorSummary": "All keys in the 'jwks' must have a unique `kid`." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorClientJsonWebKeyKidLengthTooShort": { "value": { "errorCauses": [ { "errorSummary": "RSA key length in the 'jwks' is less than '2,048' bits for the given key." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorClientJsonWebKeyNonUniqueKid": { "value": { "errorCauses": [ { "errorSummary": "Each key should have a unique kid when adding multiple keys. Use the Apps API to update the JWKS to add a kid for the existing key, or delete the existing key and re-add the key with a kid using the JWKS APIs." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorClientJsonWebKeyTooManyKids": { "value": { "errorCauses": [ { "errorSummary": "You can't create a new key. You have reached the maximum number of keys allowed (50). To add another key, you must first delete an existing one." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorClientSecretNonAscii": { "summary": "Client secret allows only ASCII error", "value": { "errorCauses": [ { "errorSummary": "client_secret: ''client_secret'' must only contain printable ASCII: [x20-x7E]+" } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: client_secret" } }, "ErrorClientSecretTooLong": { "summary": "Client secret too long error", "value": { "errorCauses": [ { "errorSummary": "client_secret: 'client_secret' can't be more than '100' characters long." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: client_secret" } }, "ErrorClientSecretTooShort": { "summary": "Client secret too short error", "value": { "errorCauses": [ { "errorSummary": "client_secret: 'client_secret' must be at least '14' characters long." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: client_secret" } }, "ErrorClientSecretTooShortWithClientSecretJWT": { "summary": "Client secret is too short for JWT error", "value": { "errorCauses": [ { "errorSummary": "client_secret: 'client_secret' must be at least '32' characters long when 'token_endpoint_auth_method' is 'client_secret_jwt'." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: client_secret" } }, "ErrorClientSecretWithPrivateKeyJWT": { "summary": "Client secret can't be used for private key JWT error", "value": { "errorCauses": [ { "errorSummary": "'client_secret' can't be used when 'token_endpoint_auth_method' is 'private_key_jwt'." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: client_secret" } }, "ErrorCreateBrandExists": { "value": { "errorCauses": [], "errorCode": "E0000202", "errorId": "oaeKABuesTdRvCXeCTpSpXAcQ", "errorLink": "E0000202", "errorSummary": "Brand name already exists." } }, "ErrorCreateUserWithExpiredPasswordWithNullPassword": { "value": { "errorCauses": [ { "errorSummary": "Could not create user. To create a user and expire their password immediately, a password must be specified." } ], "errorCode": "E0000124", "errorId": "oaeXxuZgXBySvqi1FvtkwoYCA", "errorLink": "E0000124", "errorSummary": "Could not create user. To create a user and expire their password immediately, a password must be specified." } }, "ErrorCreateUserWithExpiredPasswordWithoutActivation": { "value": { "errorCauses": [ { "errorSummary": "Could not create user. To create a user and expire their password immediately, `activate` must be true." } ], "errorCode": "E0000125", "errorId": "oaeDd77L9R-TJaD7j_rXsQ31w", "errorLink": "E0000125", "errorSummary": "Could not create user. To create a user and expire their password immediately, `activate` must be true." } }, "ErrorCreateUserWithTooManyManyGroupsResponse": { "value": { "errorCauses": [ { "errorSummary": "The number of group targets is too large" } ], "errorCode": "E0000093", "errorId": "oaePVSLIYnIQsC0B-ptBIllVA", "errorLink": "E0000093", "errorSummary": "Target count limit exceeded" } }, "ErrorDbscFeatureNotEnabled": { "summary": "Feature not enabled for org", "value": { "errorCauses": [], "errorCode": "E0000006", "errorId": "oae123abc", "errorLink": "E0000006", "errorSummary": "Device Bound Session Credentials isn't enabled" } }, "ErrorDbscNotEnabled": { "summary": "DBSC not enabled for session", "value": { "errorCauses": [], "errorCode": "E0000007", "errorId": "oae123abc", "errorLink": "E0000007", "errorSummary": "DBSC not enabled for this session" } }, "ErrorDeactivateActiveKey": { "value": { "errorCauses": [ { "errorSummary": "You cannot deactivate the active key when access token encryption is enabled." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorDeactivateEncryptionKey": { "value": { "errorCauses": [ { "errorSummary": "You can't deactivate the active encryption key." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorDeactivateTheOnlyClientSecret": { "value": { "errorCauses": [ { "errorSummary": "You can't deactivate the only active client secret." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: OAuth2ClientSecretMediated" } }, "ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod": { "value": { "errorCauses": [ { "errorSummary": "Can't deactivate the only active JSON Web Key when the value for `token_endpoint_auth_method` is `private_key_jwt`." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm": { "value": { "errorCauses": [ { "errorSummary": "The `jwks` must contain at least one key with an algorithm matching the `request_object_signature_algorithm`." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorDeleteActiveJsonWebKey": { "value": { "errorCauses": [ { "errorSummary": "You can't delete an active JSON Web Key. Deactivate the key before deleting it." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorDeleteActiveSecret": { "value": { "errorCauses": [ { "errorSummary": "You can't delete an active client secret. Deactivate the secret before deleting it." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: OAuth2ClientSecretMediated" } }, "ErrorDeleteBrandAssociatedWithDomain": { "value": { "errorCauses": [], "errorCode": "E0000201", "errorId": "oaeAdRqprFuTyKokyYPbURJkA", "errorLink": "E0000201", "errorSummary": "A brand associated with a domain cannot be deleted" } }, "ErrorDeleteCustomAsActiveJsonWebKey": { "value": { "errorCauses": [ { "errorSummary": "''ACTIVE'' keys cannot be deleted. Activate another key before deleting this one." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorDeleteDefaultBrand": { "value": { "errorCauses": [], "errorCode": "E0000200", "errorId": "oaeAdRqprFuTyKokyYPbURJkA", "errorLink": "E0000200", "errorSummary": "A default brand cannot be deleted" } }, "ErrorDeviceAssuranceInUse": { "summary": "Can't delete device assurance policy in use by app sign-in policies", "value": { "errorCauses": [], "errorId": "oaenwA1ra80S9W-pvbh4m6haA", "errorSummary": "Device assurance is in use and cannot be deleted." } }, "ErrorDevicePostureCheckInUse": { "summary": "Can't delete device posture check in use by device assurance policies", "value": { "errorCauses": [], "errorId": "oaenwA1ra80S9W-pvbh4m6haA", "errorSummary": "Device posture check is in use and can't be deleted." } }, "ErrorEmailCustomizationCannotClearDefault": { "value": { "errorCauses": [], "errorCode": "E0000185", "errorId": "oaejrB1fWL1S7mc-2KcG-SOtw", "errorLink": "E0000185", "errorSummary": "The isDefault parameter of the default email template customization can't be set to false." } }, "ErrorEmailCustomizationCannotDeleteDefault": { "value": { "errorCauses": [], "errorCode": "E0000184", "errorId": "oaeAdRqprFuTyKokyYPbURJkA", "errorLink": "E0000184", "errorSummary": "A default email template customization can't be deleted." } }, "ErrorEmailCustomizationDefaultAlreadyExists": { "value": { "errorCauses": [], "errorCode": "E0000182", "errorId": "oaeXYwTiMvASsC3O4HCzjFaCA", "errorLink": "E0000182", "errorSummary": "A default email template customization already exists." } }, "ErrorEmailCustomizationLanguageAlreadyExists": { "value": { "errorCauses": [], "errorCode": "E0000183", "errorId": "oaeUcGELffqRay0u1OPdnPypw", "errorLink": "E0000183", "errorSummary": "An email template customization for that language already exists." } }, "ErrorEmailDomainAlreadyExists": { "value": { "errorCauses": [], "errorCode": "E0000197", "errorId": "oaeEdRqprFuTyKokyYPbURJkA", "errorLink": "E0000197", "errorSummary": "Email domain already exists." } }, "ErrorEmailDomainInUse": { "value": { "errorCauses": [], "errorCode": "E0000216", "errorId": "oaeEdRqprFuTyKokyYPbURJkB", "errorLink": "E0000216", "errorSummary": "Email domain can't be deleted due to mail provider restrictions." } }, "ErrorEmailDomainInvalidStatus": { "value": { "errorCauses": [], "errorCode": "E0000217", "errorId": "oaeEdRqprFuTyKokyYPbURJkD", "errorLink": "E0000217", "errorSummary": "Invalid status. Can't validate email domain with current status." } }, "ErrorEmailDomainNotVerified": { "value": { "errorCauses": [], "errorCode": "E0000218", "errorId": "oaeEdRqprFuTyKokyYPbURJkC", "errorLink": "E0000218", "errorSummary": "Email domain couldn't be verified by mail provider." } }, "ErrorEmailSettingsRaceCondition": { "value": { "errorCauses": [], "errorCode": "E0000254", "errorId": "oaeUcGELffqRay0u1OPdnPypw", "errorLink": "E0000254", "errorSummary": "Another request has already been received for the settings for this email template. Please try again later." } }, "ErrorExpiredJwt": { "summary": "JWT has expired", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "DBSC registration JWT has expired" } }, "ErrorInternalServer": { "summary": "Internal Server Error", "value": { "errorCauses": [], "errorCode": "E0000009", "errorId": "sampleAlJ82XS2SDB_vaNIWgcA", "errorLink": "E0000000", "errorSummary": "Internal Server Error" } }, "ErrorInvalidAudience": { "summary": "Invalid JWT audience", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "Invalid JWT audience" } }, "ErrorInvalidEmailTemplateRecipients": { "value": { "errorCauses": [], "errorCode": "E0000189", "errorId": "oae8L1-UkcNTeGi5xVQ28_lww", "errorLink": "E0000189", "errorSummary": "This template does not support the recipients value." } }, "ErrorInvalidJwt": { "summary": "Invalid or malformed JWT", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "Invalid DBSC JWT" } }, "ErrorInvalidLinkedObjectDef": { "summary": "Invalid linked objection definition", "value": { "errorCauses": [ { "domain": "linkedObjects", "errorSummary": "Linked object identifier for primary is already in use.", "locationType": "body", "reason": "UNIQUE_CONSTRAINT" }, { "domain": "linkedObjects", "errorSummary": "Linked object identifier for associated is already in use.", "locationType": "body", "reason": "UNIQUE_CONSTRAINT" } ], "errorCode": "E0000127", "errorId": "oaeh5FICFF2RnqakoNofPadhw", "errorLink": "E0000127", "errorSummary": "Invalid linked objection definition. Linked object identifier is already in use." } }, "ErrorInvalidPublicKey": { "summary": "Invalid public key format", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "Invalid public key in DBSC JWT" } }, "ErrorInvalidRefreshJwt": { "summary": "Invalid refresh JWT signature", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "Invalid DBSC refresh JWT signature" } }, "ErrorInvalidSession": { "summary": "Invalid or expired session", "value": { "errorCauses": [], "errorCode": "E0000011", "errorId": "oae123abc", "errorLink": "E0000011", "errorSummary": "Invalid session" } }, "ErrorInvalidTokenProvided": { "summary": "Invalid Token Provided", "value": { "errorCauses": [], "errorCode": "E0000011", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000011", "errorSummary": "Invalid token provided" } }, "ErrorInvalidWellKnownPath": { "summary": "Invalid path", "value": { "errorCauses": [ { "errorSummary": "The specified path is not supported. Valid values: [apple-app-site-association, assetlinks.json, webauthn]." } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: request" } }, "ErrorJsonWebKeyCannotAddActiveKey": { "value": { "errorCauses": [ { "errorSummary": "Keys cannot be created with an ''ACTIVE'' status. Create an ''INACTIVE'' key and then activate it." } ], "errorCode": "E0000001,", "errorId": "sampleQPivGUj_ND5v78vbYWW,", "errorLink": "E0000001,", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorJsonWebKeyKidLengthTooShort": { "value": { "errorCauses": [ { "errorSummary": "RSA key length in the 'jwks' is less than '2,048' bits for the given key." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorJsonWebKeyNonUniqueKid": { "value": { "errorCauses": [ { "errorSummary": "Each key must have a unique ''kid''." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorJsonWebKeyTooManyKids": { "value": { "errorCauses": [ { "errorSummary": "You can't create a new key. You have reached the maximum number of keys allowed (5). To add another key, you must first delete an existing one." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorKeyCredentialCloneDuplicateKey": { "summary": "Duplicate key credential error", "value": { "errorCauses": [ { "errorSummary": "Key already exists in the list of key credentials for the target app." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: cloneKey" } }, "ErrorKeyCredentialInvalidValidity": { "summary": "Key credential invalid year error", "value": { "errorCauses": [ { "errorSummary": "Validity years out of range. It should be 2 - 10 years." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: generateKey" } }, "ErrorMaxNumberOfSecrets": { "summary": "Maximum client secrets reached error", "value": { "errorCauses": [ { "errorSummary": "You've reached the maximum number of client secrets per client." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: OAuth2ClientSecretMediated" } }, "ErrorMissingHeader": { "summary": "Missing Secure-Session-Response header", "value": { "errorCauses": [], "errorCode": "E0000028", "errorId": "oae123abc", "errorLink": "E0000028", "errorSummary": "Missing required header: Secure-Session-Response" } }, "ErrorMissingRequiredParameter": { "summary": "Missing Required Parameter", "value": { "errorCauses": [], "errorCode": "E0000028", "errorId": "sampleiCF-l7mr9XqM1NQ", "errorLink": "E0000028", "errorSummary": "The request is missing a required parameter." } }, "ErrorMissingSessionIdHeader": { "summary": "Missing Sec-Secure-Session-Id header", "value": { "errorCauses": [], "errorCode": "E0000028", "errorId": "oae123abc", "errorLink": "E0000028", "errorSummary": "Missing required header: Sec-Secure-Session-Id" } }, "ErrorNoConnectedAgents": { "value": { "errorCauses": [], "errorCode": "E0000236", "errorId": "sampleMlLvGUj_YD5v16vkYWY", "errorLink": "E0000236", "errorSummary": "There are no connected agents" } }, "ErrorOnlyOneActiveEncryptionKeyAllowed": { "value": { "errorCauses": [ { "errorSummary": "The client can have only one active encryption key in the 'jwks'." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: JsonWebKey" } }, "ErrorPinOrCredRequestsGenerationFailure": { "summary": "PIN or cred requests generation failed", "value": { "errorCauses": { "errorSummary": "There was an unexpected internal error. Please try again." }, "errorCode": "E0000001", "errorId": "oaehk3rssXQmOWDRsaFfxe8A", "errorLink": "E0000001", "errorSummary": "Api validation failed: webAuthnPreregistrationPinRequest|webAuthnPreregistrationCredentialRequest" } }, "ErrorPinOrCredResponsesProcessingFailure": { "summary": "PIN or cred response processing failed", "value": { "errorCauses": { "errorSummary": "There was an unexpected internal error. Please try again." }, "errorCode": "E0000001", "errorId": "oaehk3rssXQmOWDRsaFfxe8B", "errorLink": "E0000001", "errorSummary": "Api validation failed: pinResponseJwe|webAuthnCredResponse" } }, "ErrorPublicKeyMismatch": { "summary": "Public key doesn't match existing binding.", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "DBSC public key mismatch" } }, "ErrorPublishCSRCertDoesNotMatchCSR": { "summary": "Mismatch certificate and CSR error", "value": { "errorCauses": [ { "errorSummary": "The certificate doesn't match the CSR." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: certificate" } }, "ErrorPublishCSRCertValidityLessThan90Days": { "summary": "Certificate valid for 90 days error", "value": { "errorCauses": [ { "errorSummary": "The certificate must be valid for more than 90 days." } ], "errorCode": "E0000001", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000001", "errorSummary": "Api validation failed: certificate" } }, "ErrorPushProviderUsedByCustomAppAuthenticator": { "value": { "errorCauses": [], "errorCode": "E0000187", "errorId": "oaenwA1ra80S9W-pvbh4m6haA", "errorLink": "E0000187", "errorSummary": "Cannot delete push provider because it is being used by a custom app authenticator." } }, "ErrorResourceNotFound": { "summary": "Resource Not Found", "value": { "errorCauses": [], "errorCode": "E0000007", "errorId": "sampleMlLvGUj_YD5v16vkYWY", "errorLink": "E0000007", "errorSummary": "Not found: {0}" } }, "ErrorTargetAppType": { "value": { "errorCauses": [ { "errorSummary": "The target application must be an OIDC or SAML app." } ], "errorCode": "E0000001", "errorId": "oae7oXKyr41R7yW8Q-gMZsTrA", "errorLink": "E0000001", "errorSummary": "Api validation failed: Interclient Trust Mappings" } }, "ErrorThumbprintFailed": { "summary": "JWK thumbprint computation failed", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "Failed to compute JWK thumbprint" } }, "ErrorTooManyAllowedApps": { "value": { "errorCauses": [ { "errorSummary": "The target application cannot have more than 5 trusted apps." } ], "errorCode": "E0000001", "errorId": "oae7oXKyr41R7yW8Q-gMZsTrA", "errorLink": "E0000001", "errorSummary": "Api validation failed: Interclient Trust Mappings" } }, "ErrorTooManyRequests": { "summary": "Too Many Requests", "value": { "errorCauses": [], "errorCode": "E0000047", "errorId": "sampleQPivGUj_ND5v78vbYWW", "errorLink": "E0000047", "errorSummary": "API call exceeded rate limit due to too many requests." } }, "ErrorUnsupportedAlgorithm": { "summary": "Unsupported signing algorithm", "value": { "errorCauses": [], "errorCode": "E0000001", "errorId": "oae123abc", "errorLink": "E0000001", "errorSummary": "Unsupported DBSC algorithm. Supported: ES256, RS256" } }, "ExampleOAuth2Scope": { "summary": "Example scope", "value": { "_links": { "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/scp5yu8kLOnDzo7lh0g4" } }, "consent": "REQUIRED", "default": false, "description": "Drive car", "displayName": "Saml Jackson", "id": "scp5yu8kLOnDzo7lh0g4", "metadataPublish": "NO_CLIENTS", "name": "car:drive", "optional": false, "system": false } }, "ExampleOAuth2Scopes": { "summary": "All scopes", "value": [ { "_links": { "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/scp5yu8kLOnDzo7lh0g4" } }, "consent": "REQUIRED", "default": false, "description": "Drive car", "displayName": "Saml Jackson", "id": "scp5yu8kLOnDzo7lh0g4", "metadataPublish": "NO_CLIENTS", "name": "car:drive", "optional": false, "system": false } ] }, "ExpirePwdResponse": { "value": { "_links": { "changePassword": { "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/credentials/change_password" }, "changeRecoveryQuestion": { "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/credentials/change_recovery_question" }, "deactivate": { "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/deactivate" }, "expirePassword": { "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/expire_password" }, "forgotPassword": { "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/credentials/forgot_password" }, "resetFactors": { "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/reset_factors" }, "resetPassword": { "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR/lifecycle/reset_password" } }, "activated": "2013-06-24T16:39:19.000Z", "created": "2013-06-24T16:39:18.000Z", "credentials": { "password": {}, "provider": { "name": "OKTA", "type": "OKTA" }, "recovery_question": { "question": "Who's a major player in the cowboy scene?" } }, "id": "00ub0oNGTSWTBKOLGLNR", "lastLogin": "2013-06-24T17:39:19.000Z", "lastUpdated": "2013-06-27T16:35:28.000Z", "passwordChanged": "2013-06-24T16:39:19.000Z", "profile": { "email": "isaac.brock@example.com", "firstName": "Isaac", "lastName": "Brock", "login": "isaac.brock@example.com", "mobilePhone": "555-415-1337" }, "status": "PASSWORD_EXPIRED", "statusChanged": "2013-06-24T16:39:19.000Z" } }, "ExpirePwdWithTempPwdResponse": { "value": { "tempPassword": "F46gy7X4" } }, "ExpiredAuthorizationServerKey": { "summary": "Expired authorization server key", "value": { "_links": { "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/h5Sr3LXcpQiQlAUVPdhrdLFoIvkhRTAVs_h39bQnxlU" } }, "alg": "RS256", "e": "AQAB", "kid": "h5Sr3LXcpQiQlAUVPdhrdLFoIvkhRTAVs_h39bQnxlU", "kty": "RSA", "n": "lC4ehVB6W0OCtNPnz8udYH9Ao83B6EKnHA5eTcMOap_lQZ-nKtS1lZwBj4wXRVc1XmS0d2OQFA1VMQ-dHLDE3CiGfsGqWbaiZFdW7U GLO1nAwfDdH6xp3xwpKOMewDXbAHJlXdYYAe2ap - CE9c5WLTUBU6JROuWcorHCNJisj1aExyiY5t3JQQVGpBz2oUIHo7NRzQoKimvp dMvMzcYnTlk1dhlG11b1GTkBclprm1BmOP7Ltjd7aEumOJWS67nKcAZzl48Zyg5KtV11V9F9dkGt25qHauqFKL7w3wu - DYhT0hmyFc wn - tXS6e6HQbfHhR_MQxysLtDGOk2ViWv8AQ", "status": "EXPIRED", "use": "sig" } }, "ExpressConfiguration": { "summary": "Express configuration example", "value": { "applicationClientId": "0oa9z8y7x6w5v4u3t2s1", "capabilities": [ "SSO" ], "initiateLoginUriTemplate": "https://example.auth0.com/login/initiate", "loginDomain": "login.example.com", "oinClientId": "0oa1a2b3c4d5e6f7g8h9", "tenantDomain": "example.auth0.com" } }, "ExtendOktaSupportAccessStatus": { "summary": "Extend Okta Support access", "value": { "caseNumber": "1011001", "impersonation": { "expiration": "2024-01-25T11:13:14.000Z", "status": "ENABLED" } } }, "ExtendOktaSupportAccessStatusRequest": { "summary": "Extend Okta Support access", "value": { "impersonation": { "expiration": "2024-01-25T11:13:14.000Z" } } }, "FacebookIdPResponse": { "summary": "Facebook IdP", "value": { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62b57p7c8PaGpU0h7&\n client_id={clientId}&response_type={responseType}&response_mode={responseMode}&\n scope={scopes}&redirect_uri={redirectUri}&state={state}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2016-03-24T23:18:27.000Z", "id": "0oa62b57p7c8PaGpU0h7", "lastUpdated": "2016-03-24T23:18:27.000Z", "name": "Facebook", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": true }, "subject": { "filter": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.userPrincipalName" } }, "trustClaims": false }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://www.facebook.com/dialog/oauth" }, "token": { "binding": "HTTP-POST", "url": "https://graph.facebook.com/v2.5/oauth/access_token" } }, "scopes": [ "public_profile", "email" ], "type": "OAUTH2" }, "status": "ACTIVE", "type": "FACEBOOK" } }, "FactorEmail": { "value": { "_links": { "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3" }, "verify": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00umvfJKwXOQ1mEL50g3/factors/emfnf3gSScB8xXoXK0g3/verify" } }, "factorType": "email", "id": "emfnf3gSScB8xXoXK0g3", "profile": { "email": "changed@clouditude.net" }, "provider": "OKTA", "status": "ACTIVE", "vendorName": "OKTA" } }, "FactorPasscodeRequest": { "value": { "passCode": "123456" } }, "FactorResponseSms": { "value": { "_links": { "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms2gt8gzgEBPUWBIFHN" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" }, "verify": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms2gt8gzgEBPUWBIFHN/verify" } }, "created": "2014-06-27T20:27:26.000Z", "factorType": "sms", "id": "sms2gt8gzgEBPUWBIFHN", "lastUpdated": "2014-06-27T20:27:26.000Z", "profile": { "phoneNumber": "+1-555-415-1337" }, "provider": "OKTA", "status": "ACTIVE", "vendorName": "OKTA" } }, "ForgotPwdRecoveryQuestionRequest": { "value": { "password": { "value": "uTVM,TPw55" }, "recovery_question": { "answer": "Annie Oakley" } } }, "ForgotPwdRecoveryQuestionResponse": { "value": { "password": {}, "provider": { "name": "OKTA", "type": "OKTA" }, "recovery_question": { "question": "Who's a major player in the cowboy scene?" } } }, "ForgotPwdResponse": { "value": { "resetPasswordUrl": "https://{yourOktaDomain}/signin/reset-password/XE6wE17zmphl3KqAPFxO" } }, "GenerateFulfillmentRequestExample": { "summary": "Generate fulfillment request", "value": { "fulfillmentData": [ { "customizationId": "RXJN83", "inventoryProductId": "106", "productId": "55" } ], "fulfillmentProvider": "yubico", "userId": "00us2hPODQncCkxef0g3" } }, "GenericOidcIdpResponse": { "summary": "Generic OpenID Connect IdP", "value": { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oaulob4BFVa4zQvt0g3&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}&nonce={nonce}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2019-02-07T20:07:47.000Z", "id": "0oaulob4BFVa4zQvt0g3", "lastUpdated": "2019-02-07T20:07:47.000Z", "name": "Example OpenID Connect IdP", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": false }, "subject": { "filter": null, "matchAttribute": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.email" } }, "trustClaims": false }, "protocol": { "algorithms": { "request": { "signature": { "algorithm": "HS256", "scope": "REQUEST" } } }, "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret", "pkce_required": "true" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/authorize" }, "jwks": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/keys" }, "slo": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/slo" }, "token": { "binding": "HTTP-POST", "url": "https://idp.example.com/token" }, "userInfo": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/userinfo" } }, "issuer": { "url": "https://idp.example.com" }, "scopes": [ "openid" ], "settings": { "participateSlo": true }, "type": "OIDC" }, "status": "ACTIVE", "type": "OIDC" } }, "Get-User-Classification-Example": { "value": { "lastUpdated": "2022-05-04T19:50:52.000Z", "type": "LITE" } }, "GetApplicationsByGroupResponseEx": { "summary": "Retrieve apps assigned to a group", "value": [ { "_links": { "appLinks": [ { "href": "https://testorgone.okta.com/home/workday/0oa7vicdkRNrz59R80w6/30", "name": "login", "type": "text/html" } ], "deactivate": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/lifecycle/deactivate" }, "groups": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/groups" }, "help": { "href": "https://testorgone-admin.okta.com/app/workday/0oa7vicdkRNrz59R80w6/setup/help/SAML_2_0/external-doc", "type": "text/html" }, "logo": [ { "href": "https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6", "name": "medium", "type": "image/png" } ], "metadata": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/sso/saml/metadata", "type": "application/xml" }, "users": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/users" } }, "accessibility": { "errorRedirectUrl": null, "loginRedirectUrl": null, "selfService": false }, "created": "2021-05-17T23:10:49.000Z", "credentials": { "signing": { "kid": "wRejFXWxFlK9nnLozx5qKWQa3fg-JRXw7dvdlTjs5Pg" }, "userNameTemplate": { "template": "${source.login}", "type": "BUILT_IN" } }, "features": [], "id": "0oa7vicdkRNrz59R80w6", "label": "hrportal2", "lastUpdated": "2021-05-17T23:10:50.000Z", "name": "workday", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:workday:0oa7vicdkRNrz59R80w6", "settings": { "app": { "siteURL": "https://acme.workday.com" }, "notifications": { "vpn": { "helpUrl": null, "message": null, "network": { "connection": "DISABLED" } } }, "signOn": { "attributeStatements": [], "audienceOverride": null, "defaultRelayState": null, "destinationOverride": null, "recipientOverride": null, "ssoAcsUrlOverride": null } }, "signOnMode": "SAML_2_0", "status": "ACTIVE", "visibility": { "appLinks": { "login": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } }, { "_links": { "appLinks": [ { "href": "https://testorgone.okta.com/home/workday/0oa7vicvor8YSr9Hc0w6/30", "name": "login", "type": "text/html" } ], "deactivate": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/lifecycle/deactivate" }, "groups": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/groups" }, "help": { "href": "https://testorgone-admin.okta.com/app/workday/0oa7vicvor8YSr9Hc0w6/setup/help/SAML_2_0/external-doc", "type": "text/html" }, "logo": [ { "href": "https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6", "name": "medium", "type": "image/png" } ], "metadata": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/sso/saml/metadata", "type": "application/xml" }, "users": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/users" } }, "accessibility": { "errorRedirectUrl": null, "loginRedirectUrl": null, "selfService": false }, "created": "2021-05-17T23:10:22.000Z", "credentials": { "signing": { "kid": "wRejFXWxFlK9nnLozx5qKWQa3fg-JRXw7dvdlTjs5Pg" }, "userNameTemplate": { "template": "${source.login}", "type": "BUILT_IN" } }, "features": [], "id": "0oa7vicvor8YSr9Hc0w6", "label": "hrportal1", "lastUpdated": "2021-05-17T23:10:22.000Z", "name": "workday", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:workday:0oa7vicvor8YSr9Hc0w6", "settings": { "app": { "siteURL": "https://acme.workday.com" }, "notifications": { "vpn": { "helpUrl": null, "message": null, "network": { "connection": "DISABLED" } } }, "signOn": { "attributeStatements": [], "audienceOverride": null, "defaultRelayState": null, "destinationOverride": null, "recipientOverride": null, "ssoAcsUrlOverride": null } }, "signOnMode": "SAML_2_0", "status": "ACTIVE", "visibility": { "appLinks": { "login": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } }, { "_links": { "deactivate": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/lifecycle/deactivate" }, "groups": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/groups" }, "logo": [ { "href": "https:/example.okta.com/img/logos/logo_1.png", "name": "medium", "type": "image/png" } ], "self": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" }, "users": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/users" } }, "accessibility": { "errorRedirectUrl": null, "selfService": false }, "created": "2013-09-11T17:46:08.000Z", "credentials": { "scheme": "EDIT_USERNAME_AND_PASSWORD", "userNameTemplate": { "template": "${source.login}", "type": "BUILT_IN" } }, "features": [], "id": "0oabkvBLDEKCNXBGYUAS", "label": "Sample Plugin App", "lastUpdated": "2013-09-11T17:58:54.000Z", "name": "template_swa", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:template_swa:0oabkvBLDEKCNXBGYUAS", "settings": { "app": { "buttonField": "btn-login", "passwordField": "txtbox-password", "url": "https://example.com/login.html", "usernameField": "txtbox-username" } }, "signOnMode": "BROWSER_PLUGIN", "status": "ACTIVE", "visibility": { "appLinks": { "login": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } } ] }, "GetApplicationsByKeyResponseEx": { "summary": "Retrieve apps using a key", "value": [ { "accessibility": { "errorRedirectUrl": null, "loginRedirectUrl": null, "selfService": false }, "created": "2016-08-09T20:12:19.000Z", "credentials": { "signing": {}, "userNameTemplate": { "template": "${fn:substringBefore(source.login, \"@\")}", "type": "BUILT_IN" } }, "features": [], "id": "0oa1gjh63g214q0Hq0g4", "label": "Custom Saml 2.0 App", "lastUpdated": "2016-08-09T20:12:19.000Z", "name": "testorgone_customsaml20app_1", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4", "settings": { "app": {}, "notifications": { "vpn": { "helpUrl": null, "message": null, "network": { "connection": "DISABLED" } } }, "signOn": { "assertionEncryption": { "_embedded": { "_embedded": { "user": { "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/00ucw2RPGIUNTDQOYPOF" } }, "created": "2014-06-10T15:16:01.000Z", "credentials": { "password": {}, "userName": "user@example.com" }, "externalId": null, "id": "00ucw2RPGIUNTDQOYPOF", "lastSync": null, "lastUpdated": "2014-06-10T15:17:38.000Z", "passwordChanged": "2014-06-10T15:17:38.000Z", "scope": "USER", "status": "ACTIVE", "statusChanged": "2014-06-10T15:16:01.000Z", "syncState": "DISABLED" } }, "_links": { "deactivate": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/lifecycle/deactivate" }, "groups": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/groups" }, "logo": [ { "href": "https://example.okta.com/img/logos/logo_1.png", "name": "medium", "type": "image/png" } ], "self": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" }, "users": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/users" } }, "accessibility": { "errorRedirectUrl": null, "selfService": false }, "created": "2013-09-11T17:46:08.000Z", "credentials": { "scheme": "EDIT_USERNAME_AND_PASSWORD", "userNameTemplate": { "template": "${source.login}", "type": "BUILT_IN" } }, "features": [], "id": "0oabkvBLDEKCNXBGYUAS", "label": "Sample Plugin App", "lastUpdated": "2013-09-11T17:58:54.000Z", "name": "template_swa", "settings": { "app": { "buttonField": "btn-login", "passwordField": "txtbox-password", "url": "https://example.com/login.html", "usernameField": "txtbox-username" } }, "signOnMode": "BROWSER_PLUGIN", "status": "ACTIVE", "user": { "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabizCHPNYALCHDUIOD" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/00ucw2RPGIUNTDQOYPOF" } }, "created": "2014-03-21T23:31:35.000Z", "credentials": { "userName": "user@example.com" }, "externalId": null, "id": "00ucw2RPGIUNTDQOYPOF", "lastSync": null, "lastUpdated": "2014-03-21T23:31:35.000Z", "passwordChanged": null, "scope": "USER", "status": "ACTIVE", "statusChanged": "2014-03-21T23:31:35.000Z", "syncState": "DISABLED" }, "visibility": { "appLinks": { "login": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } }, "_links": { "appLinks": [ { "href": "https://testorgone.okta.com/home/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/aln1gofChJaerOVfY0g4", "name": "testorgone_customsaml20app_1_link", "type": "text/html" } ], "deactivate": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/lifecycle/deactivate" }, "groups": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/groups" }, "help": { "href": "https://testorgone-admin.okta.com/app/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/setup/help/SAML_2_0/instructions", "type": "text/html" }, "logo": [ { "href": "https://testorgone.okta.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", "name": "medium", "type": "image/png" } ], "metadata": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/sso/saml/metadata", "type": "application/xml" }, "users": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/users" } }, "acsEndpoints": [], "allowMultipleAcsEndpoints": false, "attributeStatements": [], "enabled": true, "encryptionAlgorithm": "AES256_GCM", "keyTransportAlgorithm": "RSA_15", "requestCompressed": false, "x5c": [ "MIIC6jCCAdKgAwIBAgIGAZKbFN7JMA0GCSqGSIb3DQEBCwUAMDYxNDAyBgNVBAMM\r\n" ] }, "assertionSigned": true, "audience": "https://example.com/tenant/123", "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "defaultRelayState": "", "destination": "https://destination.okta.com", "digestAlgorithm": "SHA256", "honorForceAuthn": true, "idpIssuer": "https://www.okta.com/${org.externalKey}", "participateSlo": { "bindingType": "REDIRECT", "enabled": true, "logoutRequestUrl": "https://testorgone.okta.com/logout/participate", "sessionIndexRequired": true }, "recipient": "https://recipient.okta.com", "responseSigned": true, "signatureAlgorithm": "RSA_SHA256", "slo": { "enabled": true, "logoutUrl": "https://testorgone.okta.com/logout", "spIssuer": "https://testorgone.okta.com" }, "spCertificate": { "x5c": [ "MIIFnDCCA4QCCQDBSLbiON2T1zANBgkqhkiG9w0BAQsFADCBjzELMAkGA1UEBhMCVVMxDjAMBgNV\r\n" ] }, "ssoAcsUrl": "https://{yourOktaDomain}", "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "subjectNameIdTemplate": "${user.userName}" } }, "signOnMode": "SAML_2_0", "status": "ACTIVE", "visibility": { "appLinks": { "testorgone_customsaml20app_1_link": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } } ] }, "GetApplicationsByNameResponseEx": { "summary": "Retrieve apps by name", "value": [ { "_links": { "appLinks": [ { "href": "https://testorgone.okta.com/home/workday/0oa7vicdkRNrz59R80w6/30", "name": "login", "type": "text/html" } ], "deactivate": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/lifecycle/deactivate" }, "groups": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/groups" }, "help": { "href": "https://testorgone-admin.okta.com/app/workday/0oa7vicdkRNrz59R80w6/setup/help/SAML_2_0/external-doc", "type": "text/html" }, "logo": [ { "href": "https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6", "name": "medium", "type": "image/png" } ], "metadata": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/sso/saml/metadata", "type": "application/xml" }, "users": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicdkRNrz59R80w6/users" } }, "accessibility": { "errorRedirectUrl": null, "loginRedirectUrl": null, "selfService": false }, "created": "2021-05-17T23:10:49.000Z", "credentials": { "signing": { "kid": "wRejFXWxFlK9nnLozx5qKWQa3fg-JRXw7dvdlTjs5Pg" }, "userNameTemplate": { "template": "${source.login}", "type": "BUILT_IN" } }, "features": [], "id": "0oa7vicdkRNrz59R80w6", "label": "hrportal2", "lastUpdated": "2021-05-17T23:10:50.000Z", "name": "workday", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:workday:0oa7vicdkRNrz59R80w6", "settings": { "app": { "siteURL": "https://acme.workday.com" }, "notifications": { "vpn": { "helpUrl": null, "message": null, "network": { "connection": "DISABLED" } } }, "signOn": { "attributeStatements": [], "audienceOverride": null, "defaultRelayState": null, "destinationOverride": null, "recipientOverride": null, "ssoAcsUrlOverride": null } }, "signOnMode": "SAML_2_0", "status": "ACTIVE", "visibility": { "appLinks": { "login": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } }, { "_links": { "appLinks": [ { "href": "https://testorgone.okta.com/home/workday/0oa7vicvor8YSr9Hc0w6/30", "name": "login", "type": "text/html" } ], "deactivate": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/lifecycle/deactivate" }, "groups": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/groups" }, "help": { "href": "https://testorgone-admin.okta.com/app/workday/0oa7vicvor8YSr9Hc0w6/setup/help/SAML_2_0/external-doc", "type": "text/html" }, "logo": [ { "href": "https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6", "name": "medium", "type": "image/png" } ], "metadata": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/sso/saml/metadata", "type": "application/xml" }, "users": { "href": "https://testorgone.okta.com/api/v1/apps/0oa7vicvor8YSr9Hc0w6/users" } }, "accessibility": { "errorRedirectUrl": null, "loginRedirectUrl": null, "selfService": false }, "created": "2021-05-17T23:10:22.000Z", "credentials": { "signing": { "kid": "wRejFXWxFlK9nnLozx5qKWQa3fg-JRXw7dvdlTjs5Pg" }, "userNameTemplate": { "template": "${source.login}", "type": "BUILT_IN" } }, "features": [], "id": "0oa7vicvor8YSr9Hc0w6", "label": "hrportal1", "lastUpdated": "2021-05-17T23:10:22.000Z", "name": "workday", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:workday:0oa7vicdkRNrz59R80w6", "settings": { "app": { "siteURL": "https://acme.workday.com" }, "notifications": { "vpn": { "helpUrl": null, "message": null, "network": { "connection": "DISABLED" } } }, "signOn": { "attributeStatements": [], "audienceOverride": null, "defaultRelayState": null, "destinationOverride": null, "recipientOverride": null, "ssoAcsUrlOverride": null } }, "signOnMode": "SAML_2_0", "status": "ACTIVE", "visibility": { "appLinks": { "login": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } } ] }, "GetApplicationsByUserResponseEx": { "summary": "Retrieve apps assigned to a user", "value": [ { "accessibility": { "errorRedirectUrl": null, "loginRedirectUrl": null, "selfService": false }, "created": "2016-08-09T20:12:19.000Z", "credentials": { "signing": {}, "userNameTemplate": { "template": "${fn:substringBefore(source.login, \"@\")}", "type": "BUILT_IN" } }, "features": [], "id": "0oa1gjh63g214q0Hq0g4", "label": "Custom Saml 2.0 App", "lastUpdated": "2016-08-09T20:12:19.000Z", "name": "testorgone_customsaml20app_1", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4", "settings": { "app": {}, "notifications": { "vpn": { "helpUrl": null, "message": null, "network": { "connection": "DISABLED" } } }, "signOn": { "assertionEncryption": { "_embedded": { "_embedded": { "user": { "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/00ucw2RPGIUNTDQOYPOF" } }, "created": "2014-06-10T15:16:01.000Z", "credentials": { "password": {}, "userName": "user@example.com" }, "externalId": null, "id": "00ucw2RPGIUNTDQOYPOF", "lastSync": null, "lastUpdated": "2014-06-10T15:17:38.000Z", "passwordChanged": "2014-06-10T15:17:38.000Z", "scope": "USER", "status": "ACTIVE", "statusChanged": "2014-06-10T15:16:01.000Z", "syncState": "DISABLED" } }, "_links": { "deactivate": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/lifecycle/deactivate" }, "groups": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/groups" }, "logo": [ { "href": "https://example.okta.com/img/logos/logo_1.png", "name": "medium", "type": "image/png" } ], "self": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS" }, "users": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabkvBLDEKCNXBGYUAS/users" } }, "accessibility": { "errorRedirectUrl": null, "selfService": false }, "created": "2013-09-11T17:46:08.000Z", "credentials": { "scheme": "EDIT_USERNAME_AND_PASSWORD", "userNameTemplate": { "template": "${source.login}", "type": "BUILT_IN" } }, "features": [], "id": "0oabkvBLDEKCNXBGYUAS", "label": "Sample Plugin App", "lastUpdated": "2013-09-11T17:58:54.000Z", "name": "template_swa", "settings": { "app": { "buttonField": "btn-login", "passwordField": "txtbox-password", "url": "https://example.com/login.html", "usernameField": "txtbox-username" } }, "signOnMode": "BROWSER_PLUGIN", "status": "ACTIVE", "user": { "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabizCHPNYALCHDUIOD" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/00ucw2RPGIUNTDQOYPOF" } }, "created": "2014-03-21T23:31:35.000Z", "credentials": { "userName": "user@example.com" }, "externalId": null, "id": "00ucw2RPGIUNTDQOYPOF", "lastSync": null, "lastUpdated": "2014-03-21T23:31:35.000Z", "passwordChanged": null, "scope": "USER", "status": "ACTIVE", "statusChanged": "2014-03-21T23:31:35.000Z", "syncState": "DISABLED" }, "visibility": { "appLinks": { "login": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } }, "_links": { "appLinks": [ { "href": "https://testorgone.okta.com/home/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/aln1gofChJaerOVfY0g4", "name": "testorgone_customsaml20app_1_link", "type": "text/html" } ], "deactivate": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/lifecycle/deactivate" }, "groups": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/groups" }, "help": { "href": "https://testorgone-admin.okta.com/app/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/setup/help/SAML_2_0/instructions", "type": "text/html" }, "logo": [ { "href": "https://testorgone.okta.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", "name": "medium", "type": "image/png" } ], "metadata": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/sso/saml/metadata", "type": "application/xml" }, "users": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/users" } }, "acsEndpoints": [], "allowMultipleAcsEndpoints": false, "attributeStatements": [], "enabled": false, "requestCompressed": false }, "assertionSigned": true, "audience": "https://example.com/tenant/123", "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "defaultRelayState": "", "destination": "https://destination.okta.com", "digestAlgorithm": "SHA256", "honorForceAuthn": true, "idpIssuer": "https://www.okta.com/${org.externalKey}", "participateSlo": { "bindingType": "REDIRECT", "enabled": true, "logoutRequestUrl": "https://testorgone.okta.com/logout/participate", "sessionIndexRequired": true }, "recipient": "https://recipient.okta.com", "responseSigned": true, "signatureAlgorithm": "RSA_SHA256", "slo": { "enabled": true, "logoutUrl": "https://testorgone.okta.com/logout", "spIssuer": "https://testorgone.okta.com" }, "spCertificate": { "x5c": [ "MIIFnDCCA4QCCQDBSLbiON2T1zANBgkqhkiG9w0BAQsFADCBjzELMAkGA1UEBhMCVVMxDjAMBgNV\r\n" ] }, "ssoAcsUrl": "https://{yourOktaDomain}", "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "subjectNameIdTemplate": "${user.userName}" } }, "signOnMode": "SAML_2_0", "status": "ACTIVE", "visibility": { "appLinks": { "testorgone_customsaml20app_1_link": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } } ] }, "GetApplicationsResponseEx": { "summary": "Retrieve an app", "value": { "_links": { "appLinks": [ { "href": "https://testorgone.okta.com/home/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/aln1gofChJaerOVfY0g4", "name": "testorgone_customsaml20app_1_link", "type": "text/html" } ], "deactivate": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/lifecycle/deactivate" }, "groups": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/groups" }, "help": { "href": "https://testorgone-admin.okta.com/app/testorgone_customsaml20app_1/0oa1gjh63g214q0Hq0g4/setup/help/SAML_2_0/instructions", "type": "text/html" }, "logo": [ { "href": "https://testorgone.okta.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", "name": "medium", "type": "image/png" } ], "metadata": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/sso/saml/metadata", "type": "application/xml" }, "users": { "href": "https://testorgone.okta.com/api/v1/apps/0oa1gjh63g214q0Hq0g4/users" } }, "accessibility": { "errorRedirectUrl": null, "loginRedirectUrl": null, "selfService": false }, "created": "2016-08-09T20:12:19.000Z", "credentials": { "signing": {}, "userNameTemplate": { "template": "${fn:substringBefore(source.login, \"@\")}", "type": "BUILT_IN" } }, "expressConfiguration": { "enabledCapabilities": [ "SSO" ], "supportedCapabilities": [ "SSO", "PROVISIONING", "UNIVERSAL_LOGOUT" ] }, "features": [], "id": "0oa1gjh63g214q0Hq0g4", "label": "Custom Saml 2.0 App", "lastUpdated": "2016-08-09T20:12:19.000Z", "name": "testorgone_customsaml20app_1", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4", "settings": { "app": {}, "notifications": { "vpn": { "helpUrl": null, "message": null, "network": { "connection": "DISABLED" } } }, "signOn": { "acsEndpoints": [], "allowMultipleAcsEndpoints": false, "assertionEncryption": { "enabled": true, "encryptionAlgorithm": "AES256_GCM", "keyTransportAlgorithm": "RSA_15", "x5c": [ "MIIC6jCCAdKgAwIBAgIGAZKbFN7JMA0GCSqGSIb3DQEBCwUAMDYxNDAyBgNVBAMM\r\n" ] }, "assertionSigned": true, "attributeStatements": [], "audience": "https://example.com/tenant/123", "authnContextClassRef": "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "defaultRelayState": "", "destination": "https://destination.okta.com", "digestAlgorithm": "SHA256", "honorForceAuthn": true, "idpIssuer": "https://www.okta.com/${org.externalKey}", "inlineHooks": [ { "_links": { "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/inlineHooks/cal3ughy17pylLxQB357" } }, "id": "cal3ughy17pylLxQB357" } ], "participateSlo": { "bindingType": "REDIRECT", "enabled": true, "logoutRequestUrl": "https://testorgone.okta.com/logout/participate", "sessionIndexRequired": true }, "recipient": "https://recipient.okta.com", "requestCompressed": false, "responseSigned": true, "signatureAlgorithm": "RSA_SHA256", "slo": { "enabled": true, "logoutUrl": "https://testorgone.okta.com/logout", "spIssuer": "https://testorgone.okta.com" }, "spCertificate": { "x5c": [ "MIIFnDCCA4QCCQDBSLbiON2T1zANBgkqhkiG9w0BAQsFADCBjzELMAkGA1UEBhMCVVMxDjAMBgNV\r\n" ] }, "ssoAcsUrl": "https://{yourOktaDomain}", "subjectNameIdFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "subjectNameIdTemplate": "${user.userName}" } }, "signOnMode": "SAML_2_0", "status": "ACTIVE", "universalLogout": { "identityStack": "NOT_SHARED", "protocol": "GLOBAL_TOKEN_REVOCATION", "status": "ENABLED", "supportType": "FULL" }, "visibility": { "appLinks": { "testorgone_customsaml20app_1_link": true }, "autoSubmitToolbar": false, "hide": { "iOS": false, "web": false } } } }, "GetAssociatedLinkedObjectsResponse": { "summary": "Retrieve all associated linked object values response", "value": [ { "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u5zex6ztMbOZhF50h7" } } }, { "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u1tsf0nQKavLDUh0g5" } } } ] }, "GetBrandResponse": { "value": { "_links": { "emailDomain": { "hints": { "allow": [ "GET", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/email-domains/OeD114iNkrcN6aR680g4" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4" }, "themes": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/themes" } }, "agreeToCustomPrivacyPolicy": false, "customPrivacyPolicyUrl": null, "defaultApp": { "appInstanceId": "0oa114iNkrcN6aR680g4", "appLinkName": null, "classicApplicationUri": null }, "emailDomainId": "OeD114iNkrcN6aR680g4", "id": "bnd114iNkrcN6aR680g4", "isDefault": true, "locale": "en", "name": "Okta Default", "removePoweredByOkta": false } }, "GetEmailTemplateResponse": { "value": { "_embedded": { "customizationCount": 0, "settings": { "_links": { "self": { "hints": { "allow": [ "GET", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" }, "template": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" } }, "recipients": "ALL_USERS" } }, "_links": { "customizations": { "hints": { "allow": [ "GET", "POST", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations" }, "defaultContent": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" }, "settings": { "hints": { "allow": [ "GET", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" }, "test": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" } }, "name": "UserActivation" } }, "GetPrimaryLinkedObjectResponse": { "summary": "Retrieve primary linked object value response", "value": [ { "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7" } } } ] }, "GetRealmAssignmentResponse": { "value": { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/realm-assignments/rul2jy7jLUlnO3ng00g4", "method": "GET", "rel": "self" } }, "actions": { "assignUserToRealm": { "realmId": "00g1b7rvh0xPLKXFf0g5" } }, "conditions": { "expression": { "value": "string" }, "profileSourceId": "0oa4enoRyjwSCy5hx0g4" }, "created": "2022-04-04T15:56:05.000Z", "domains": [ "atko.com", "user.com" ], "id": "rul2jy7jLUlnO3ng00g4", "isDefault": false, "lastUpdated": "2022-05-05T18:15:44.000Z", "name": "Realm Assignment 1", "priority": 0, "status": "ACTIVE" } }, "GetRoleAssignmentGovernanceGrantResources": { "value": { "_links": { "next": { "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4/resources?after=orn:okta:directory:00ozmkUsqWxsUxhGO0g3:groups:00g118990hl1oCC5A0g5" }, "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4/resources" } }, "resources": [ { "label": "test-group-1", "resource": "orn:okta:directory:00ozmkUsqWxsUxhGO0g3:groups:00g114290ar1oCC5A0g5" }, { "label": "test-group-2", "resource": "orn:okta:directory:00ozmkUsqWxsUxhGO0g3:groups:00g118990hl1oCC5B0g5" } ] } }, "GetRoleAssignmentGovernanceGrantResponse": { "value": { "_links": { "resources": { "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4/resources" }, "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4" } }, "bundleId": "enbhz2pAwtts9UBes0g4", "expirationDate": "2024-12-09 14:17:22.0", "grantId": "grai2556vZgWesWf10g4", "type": "ENTITLEMENT-BUNDLE" } }, "GetSessionResponse": { "value": { "created": "2022-04-04T15:56:05.000Z", "id": "aps1qqonvr2SZv6o70h8", "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", "importType": "INCREMENTAL", "lastUpdated": "2022-05-05T16:15:44.000Z", "status": "CREATED" } }, "GetThemeResponse": { "value": { "backgroundImage": null, "emailTemplateTouchPointVariant": "OKTA_DEFAULT", "endUserDashboardTouchPointVariant": "OKTA_DEFAULT", "errorPageTouchPointVariant": "OKTA_DEFAULT", "favicon": "https://{yourOktaDomain}/favicon.ico", "id": "thdul904tTZ6kWVhP0g3", "loadingPageTouchPointVariant": "OKTA_DEFAULT", "logo": "https://{yourOktaDomain}/assets/img/logos/okta-logo.47066819ac7db5c13f4c431b2687cef6.png", "primaryColorContrastHex": "#000000", "primaryColorHex": "#1662dd", "secondaryColorContrastHex": "#000000", "secondaryColorHex": "#ebebed", "signInPageTouchPointVariant": "OKTA_DEFAULT" } }, "GetUseRoleGovernanceResponse": { "value": { "_links": { "assignee": { "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5\"" }, "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance" } }, "grants": [ { "_links": { "resources": { "href": "https://{yourOktaDomain}/api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai24zWTjnDazeOI0g4/resources" } }, "grantId": "grai24zWTjnDazeOI0g4", "type": "CUSTOM" }, { "_links": { "resources": { "href": "https://{yourOktaDomain}//api/v1/users/00u15r0i2hC4jeTne0g5/roles/KVJUKUS7IFCE2SKO/governance/grai2556vZgWesWf10g4/resources" } }, "bundleId": "enbhz2pAwtts9UBes0g4", "expirationDate": "2024-12-09 14:17:22.0", "grantId": "grai2556vZgWesWf10g4", "type": "ENTITLEMENT-BUNDLE" } ] } }, "GetUserLinkedObjectResponse": { "summary": "Retrieve user linked object value", "value": [ { "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7" } } } ] }, "GetUserResponse": { "summary": "Retrieve a user type response", "value": { "_links": { "schema": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" }, "self": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" } }, "created": "2021-07-05T20:40:38.000Z", "createdBy": "sprz9fj1ycBcsgopy1d6", "default": false, "description": "A new custom user type", "displayName": "New user type", "id": "otyfnly5cQjJT9PnR0g4", "lastUpdated": "2021-07-05T20:40:38.000Z", "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", "name": "newUserType" } }, "GetYubikeyOptTokenResponse": { "summary": "Get YubiKey OTP token response", "value": { "_links": { "deactivate": { "hints": { "allow": [ "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00uu0x8sxTr9HcHOo0g3/factors/ykfxduQAhl89YyPrV0g3" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/org/factors/yubikey_token/tokens/ykkxdtCA1fKVxyu6R0g3" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00uu0x8sxTr9HcHOo0g3" } }, "activated": "2020-06-09T23:47:29.000Z", "created": "2020-06-09T23:42:05.000Z", "id": "ykkxdtCA1fKVxyu6R0g3", "lastUpdated": "2020-06-09T23:47:29.000Z", "lastVerified": "2020-06-09T23:47:29.000Z", "profile": { "serial": "000009508427" }, "status": "ACTIVE" } }, "GoogleIdPResponse": { "summary": "Google IdP", "value": { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62bfdiumsUndnZ0h7&\n client_id={clientId}&response_type={responseType}&response_mode={responseMode}&\n scope={scopes}&redirect_uri={redirectUri}&state={state}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2016-03-24T23:21:49.000Z", "id": "0oa62bfdiumsUndnZ0h7", "lastUpdated": "2016-03-24T23:21:49.000Z", "name": "Google", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": true }, "subject": { "filter": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.userPrincipalName" } }, "trustClaims": false }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://accounts.google.com/o/oauth2/auth" }, "token": { "binding": "HTTP-POST", "url": "https://www.googleapis.com/oauth2/v3/token" } }, "scopes": [ "profile", "email", "openid" ], "type": "OIDC" }, "status": "ACTIVE", "type": "GOOGLE" } }, "GovernanceBundle": { "summary": "Governance bundle", "value": { "_links": { "entitlements": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA/entitlements", "self": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA" }, "description": "Group bundle for administrative access", "id": "0bbfxqCAJWWGELFTYAAA", "name": "Group admin bundle", "orn": "orn:okta:governance:00o5rb5mt2H3d1TJd0h7:bundles:0bbfxqCAJWWGELFTYAAA", "status": "ACTIVE" } }, "GovernanceBundleCreateRequestCustomRole": { "summary": "Create governance bundle with custom role", "value": { "description": "Custom bundle for administrative access", "entitlements": { "resourceSets": [ "iamoJDFKaJxGIr0oamd9g" ], "role": "cr0WxyzJxGIr0ouum0g4" }, "name": "Custom admin bundle" } }, "GovernanceBundleCreateRequestScopedStandardRole": { "summary": "Create governance bundle with scoped standard role", "value": { "description": "Group bundle for administrative access", "entitlements": { "role": "GROUP_MEMBERSHIP_ADMIN", "targets": [ "00guaxWZ0AOa5NFAj0g3" ] }, "name": "Group admin bundle" } }, "GovernanceBundleCreateRequestStandardRole": { "summary": "Create governance bundle with non-scoped standard role", "value": { "description": "Group bundle for administrative access", "entitlements": { "role": "GROUP_MEMBERSHIP_ADMIN" }, "name": "Group admin bundle" } }, "GovernanceBundleUpdateRequestCustomRole": { "summary": "Update governance bundle with custom role", "value": { "description": "Custom bundle for administrative access", "entitlements": { "resourceSets": [ "iamoJDFKaJxGIr0oamd9g" ], "role": "cr0WxyzJxGIr0ouum0g4" }, "name": "Custom admin bundle" } }, "GovernanceBundleUpdateRequestScopedStandardRole": { "summary": "Update governance bundle with scoped standard role", "value": { "description": "Group bundle for administrative access", "entitlements": { "role": "GROUP_MEMBERSHIP_ADMIN", "targets": [ "00guaxWZ0AOa5NFAj0g3" ] }, "name": "Group admin bundle" } }, "GovernanceBundleUpdateRequestStandardRole": { "summary": "Update governance bundle with non-scoped standard role", "value": { "description": "Group bundle for administrative access", "entitlements": { "role": "GROUP_MEMBERSHIP_ADMIN" }, "name": "Group admin bundle" } }, "GovernanceBundlesResponse": { "summary": "List of governance bundles", "value": { "_links": { "next": { "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles?after=bundleId12" }, "self": { "href": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles?limit=2&after=10" } }, "bundles": [ { "_links": { "entitlements": "http://your-subdomain.okta.com/api/v1/iam/governance/bundles/0bbfxqCAJWWGELFTYAAA/entitlements" }, "description": "Group bundle for administrative access", "id": "0bbfxqCAJWWGELFTYAAA", "name": "Group admin bundle", "orn": "orn:okta:governance:00o5rb5mt2H3d1TJd0h7:bundles:0bbfxqCAJWWGELFTYAAA", "status": "ACTIVE" } ] } }, "GroupAssignmentExListResponse": { "summary": "Application groups list with embedded metadata", "value": [ { "_embedded": { "metadata": { "credentials": {}, "profile": { "department": { "lastUpdated": null, "source": { "type": "MAPPING", "value": [ { "id": null } ] } }, "division": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "initialStatus": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "locale": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "manager": { "lastUpdated": null, "source": { "type": "MAPPING", "value": [ { "id": null } ] } }, "managerId": { "lastUpdated": null, "source": { "type": "MAPPING", "value": [ { "id": null } ] } }, "organization": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "preferredLanguage": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "securityAnswer": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "securityQuestion": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "timezone": { "lastUpdated": null, "source": { "type": "USER", "value": [ { "id": "00uzojLwDGgUynjJS0g3", "self": { "href": "http://{yourOktaDomain}/api/v1/users/00uzojLwDGgUynjJS0g3" } } ] } }, "userType": { "lastUpdated": null, "source": { "type": "MAPPING", "value": [ { "id": null } ] } } } } }, "_links": { "app": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" }, "group": { "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" }, "self": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" } }, "id": "00g15acRUy0SYb9GT0g4", "lastUpdated": "2024-06-02T13:17:57.000Z", "priority": 0, "profile": { "department": "marketing", "division": "top", "initialStatus": "active_with_pass", "locale": "en_US", "manager": "Donald Glover", "managerId": "ike.ogb@gmail.com", "organization": "wazobia", "preferredLanguage": "English", "securityAnswer": "Ronaldinho", "securityQuestion": "Who is the footballer to have played the game", "timezone": "Canada/Eastern", "userType": null } } ] }, "GroupAssignmentExResponse": { "summary": "Application group response", "value": { "_links": { "app": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" }, "group": { "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" }, "self": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" } }, "id": "00g15acRUy0SYb9GT0g4", "lastUpdated": "2024-06-02T13:17:57.000Z", "priority": 0, "profile": { "department": "marketing", "division": "top", "initialStatus": "active_with_pass", "locale": "en_US", "manager": "Donald Glover", "managerId": "ike.ogb@gmail.com", "organization": "wazobia", "preferredLanguage": "English", "securityAnswer": "Ronaldinho", "securityQuestion": "Who is the footballer to have played the game", "timezone": "Canada/Eastern", "userType": null } } }, "GroupAssignmentPatchRequestExample": { "summary": "Update app group request", "value": [ { "op": "replace", "path": "/profile/manager", "value": "Carlo Ancelotti" } ] }, "GroupAssignmentPatchResponseExample": { "summary": "Update application group response", "value": { "_links": { "app": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" }, "group": { "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" }, "self": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" } }, "id": "00g15acRUy0SYb9GT0g4", "lastUpdated": "2024-06-03T13:42:20.000Z", "priority": 0, "profile": { "department": "Accounting", "division": "top", "initialStatus": "active_with_pass", "locale": "en_US", "manager": "Carlo Ancelotti", "managerId": "ike.ogb@gmail.com", "organization": null, "preferredLanguage": "English", "securityAnswer": "Jay Jay Okocha", "securityQuestion": "Who is the footballer to have played the game", "timezone": "Canada/Eastern", "userType": null } } }, "GroupAssignmentPutRequestExample": { "summary": "Assign application group request", "value": { "id": "00g15acRUy0SYb9GT0g4", "profile": { "department": "Accounting", "division": "top", "initialStatus": "active_with_pass", "locale": "en_US", "manager": "Arsene Wenger", "managerId": "ike.ogb@gmail.com", "organization": null, "preferredLanguage": "English", "securityAnswer": "Jay Jay Okocha", "securityQuestion": "Who is the footballer to have played the game", "timezone": "Canada/Eastern", "userType": null } } }, "GroupAssignmentPutResponseExample": { "summary": "Assign application group response", "value": { "_links": { "app": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4" }, "group": { "href": "http://{yourOktaDomain}/api/v1/groups/00g15acRUy0SYb9GT0g4" }, "self": { "href": "http://{yourOktaDomain}/api/v1/apps/0oa15anjcUHSI6hTB0g4/groups/00g15acRUy0SYb9GT0g4" } }, "id": "00g15acRUy0SYb9GT0g4", "lastUpdated": "2024-06-03T13:52:07.000Z", "priority": 0, "profile": { "department": "Accounting", "division": "top", "initialStatus": "active_with_pass", "locale": "en_US", "manager": "Arsene Wenger", "managerId": "ike.ogb@gmail.com", "organization": null, "preferredLanguage": "English", "securityAnswer": "Jay Jay Okocha", "securityQuestion": "Who is the footballer to have played the game", "timezone": "Canada/Eastern", "userType": null } } }, "GroupMemberships": { "value": { "memberExternalIds": [ "USEREXT123456784C2IFA", "USEREXT123456784C3IFB", "USEREXT123456784C4IFC" ] } }, "GroupSchemaAddRequest": { "value": { "definitions": { "custom": { "id": "#custom", "properties": { "groupContact": { "description": "Group administrative contact", "maxLength": 20, "minLength": 1, "permissions": [ { "action": "READ_WRITE", "principal": "SELF" } ], "required": false, "title": "Group administrative contact", "type": "string" } }, "required": [], "type": "object" } } } }, "GroupSchemaResponse": { "value": { "$schema": "http://json-schema.org/draft-04/schema#", "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/group/default", "method": "GET", "rel": "self" } }, "created": "2021-01-30T00:18:24.000Z", "definitions": { "base": { "id": "#base", "properties": {}, "required": [ "name" ], "type": "object" }, "custom": { "id": "#custom", "properties": { "groupContact": { "description": "Group administrative contact", "master": { "type": "PROFILE_MASTER" }, "mutability": "READ_WRITE", "permissions": [ { "action": "READ_WRITE", "principal": "SELF" } ], "scope": "NONE", "title": "Group administrative contact", "type": "string" } }, "required": [], "type": "object" } }, "description": "Okta group profile template", "id": "https://{yourOktaDomain}/meta/schemas/group/default", "lastUpdated": "2021-02-25T23:05:31.000Z", "name": "group", "properties": { "profile": { "allOf": [ { "$ref": "#/definitions/custom" }, { "$ref": "#/definitions/base" } ] } }, "title": "Okta group", "type": "object" } }, "GroupsPayload": { "value": { "externalId": "GROUPEXT123456784C2IF", "profile": { "description": "All users West of The Rockies", "displayName": "West Coast users" } } }, "GroupsResponse": { "value": { "externalId": "GROUPEXT123456784C2IF", "id": "00gsl4xM9ys8TdnbZ0g4", "profile": { "description": "All users West of The Rockies", "displayName": "West Coast users" } } }, "IAMStandardRoleResponseClient": { "value": { "_links": { "assignee": { "href": "https://{yourOktaDomain}/api/v1/client/0oa5vymVNCe2cPEeZ0g4" }, "member": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_REQUESTS_ADMIN/members/irb4jlomnnDBuBDyJ0g7" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN/permissions" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN" } }, "assignmentType": "CLIENT", "created": "2023-07-06T21:52:48.000Z", "id": "irb4jlodtdN4yJ88b0g7", "label": "Access Requests Administrator", "lastUpdated": "2023-07-06T21:52:48.000Z", "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", "role": "ACCESS_REQUESTS_ADMIN", "status": "ACTIVE", "type": "ACCESS_REQUESTS_ADMIN" } }, "IAMStandardRoleResponseUser": { "value": { "_links": { "assignee": { "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" }, "member": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_REQUESTS_ADMIN/members/irb1q92TFAHzySt3x0g4" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN/permissions" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_REQUESTS_ADMIN" } }, "assignmentType": "USER", "created": "2019-02-06T16:20:57.000Z", "id": "irb1q92TFAHzySt3x0g4", "label": "Access Requests administrator", "lastUpdated": "2019-02-06T16:20:57.000Z", "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", "role": "ACCESS_REQUESTS_ADMIN", "status": "ACTIVE", "type": "ACCESS_REQUESTS_ADMIN" } }, "IAMStandardRolesListResponse": { "value": [ { "_links": { "assignee": { "href": "https://{yourOktaDomain}/api/v1/users/00ur32Vg0fvpyHZeQ0g3" } }, "assignmentType": "USER", "created": "2019-02-06T16:17:40.000Z", "id": "IFIFAX2BIRGUSTQ", "label": "Application administrator", "lastUpdated": "2019-02-06T16:17:40.000Z", "status": "ACTIVE", "type": "APP_ADMIN" }, { "_links": { "assignee": { "href": "https://{yourOktaDomain}/api/v1/users/00u1gytb3XCr9Dkr18r2" }, "member": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g/bindings/cr0Yq6IJxGIr0ouum0g3/members/irb1qe6PGuMc7Oh8N0g4" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/cr0Yq6IJxGIr0ouum0g3/permissions" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/iamoJDFKaJxGIr0oamd9g" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" } }, "assignmentType": "USER", "created": "2019-02-06T16:20:57.000Z", "id": "irb1q92TFAHzySt3x0g4", "label": "UserCreatorRole", "lastUpdated": "2019-02-06T16:20:57.000Z", "resource-set": "iamoJDFKaJxGIr0oamd9g", "role": "cr0Yq6IJxGIr0ouum0g3", "status": "ACTIVE", "type": "CUSTOM" }, { "_links": { "assignee": { "href": "https://{yourOktaDomain}/api/v1/users/00u1gytb3XCr9Dkr18r2" }, "member": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_CERTIFICATIONS_ADMIN/members/irb1qe6PGuMc7Oh8N0g4" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/OKTA_IAM_TEST_DELIVERED_ROLE/permissions" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_CERTIFICATIONS_ADMIN" } }, "assignmentType": "USER", "created": "2019-02-06T16:20:57.000Z", "id": "irb5e92YgBazyyQ3x1q5", "label": "Access Certifications administrator", "lastUpdated": "2019-02-06T16:20:57.000Z", "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", "role": "ACCESS_CERTIFICATIONS_ADMIN", "status": "ACTIVE", "type": "ACCESS_CERTIFICATIONS_ADMIN" } ] }, "IAMStandardRolesListResponseClient": { "value": [ { "_links": { "assignee": { "href": "https://{yourOktaDomain}/api/v1/clients/0oa4ee9vgbIuqTUvd0g7" }, "member": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_CERTIFICATIONS_ADMIN/members/irb1qe6PGuMc7Oh8N0g4" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/OKTA_IAM_TEST_DELIVERED_ROLE/permissionsZ" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_CERTIFICATIONS_ADMIN" } }, "assignmentType": "CLIENT", "created": "2019-02-06T16:20:57.000Z", "id": "irb5e92YgBazyyQ3x1q5", "label": "Access Certifications Administrator", "lastUpdated": "2019-02-06T16:20:57.000Z", "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", "role": "ACCESS_CERTIFICATIONS_ADMIN", "status": "ACTIVE", "type": "ACCESS_CERTIFICATIONS_ADMIN" } ] }, "IAMStandardRolesListResponseGroup": { "value": [ { "_links": { "assignee": { "href": "https://{yourOktaDomain}/api/v1/groups/00g1emaKYZTWRYYRRTSK" }, "member": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY/bindings/ACCESS_CERTIFICATIONS_ADMIN/members/irb1qe6PGuMc7Oh8N0g4" }, "permissions": { "href": "https://{yourOktaDomain}/api/v1/iam/permission-sets/OKTA_IAM_TEST_DELIVERED_ROLE/permissions" }, "resource-set": { "href": "https://{yourOktaDomain}/api/v1/iam/resource-sets/ACCESS_CERTIFICATIONS_IAM_POLICY" }, "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/ACCESS_CERTIFICATIONS_ADMIN" } }, "assignmentType": "GROUP", "created": "2019-02-06T16:20:57.000Z", "id": "irb5e92YgBazyyQ3x1q5", "label": "Access Certifications Administrator", "lastUpdated": "2019-02-06T16:20:57.000Z", "resource-set": "ACCESS_CERTIFICATIONS_IAM_POLICY", "role": "ACCESS_CERTIFICATIONS_ADMIN", "status": "ACTIVE", "type": "ACCESS_CERTIFICATIONS_ADMIN" } ] }, "IdPAppUserResponse": { "summary": "IdP user", "value": { "_links": { "idp": { "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdiumsUndnZ0h7" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdiumsUndnZ0h7/users/00u5t60iloOHN9pBi0h7" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7" } }, "created": "2017-12-19T17:30:16.000Z", "externalId": "externalId", "id": "00u5t60iloOHN9pBi0h7", "lastUpdated": "2017-12-19T17:30:16.000Z", "profile": { "displayName": null, "email": null, "firstName": null, "honorificPrefix": null, "honorificSuffix": null, "lastName": null, "middleName": null, "profileUrl": null } } }, "IdPKeyCredentialRequest": { "summary": "IdP key credential", "value": { "e": "65537", "n": "101438407598598116085679865987760095721749307901605456708912786847324207000576780508113360584555007890315805735307890113536927352312915634368993759211767770602174860126854831344273970871509573365292777620005537635317282520456901584213746937262823585533063042033441296629204165064680610660631365266976782082747", "x5c": [ "MIIDnjCCAoagAwIBAgIGAVG3MN+PMA0GCSqGSIb3DQEBBQUAMIGPMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEDAOBgNVBAMMB2V4YW1wbGUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMTUxMjE4MjIyMjMyWhcNMjUxMjE4MjIyMzMyWjCBjzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRAwDgYDVQQDDAdleGFtcGxlMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtcnyvuVCrsFEKCwHDenS3Ocjed8eWDv3zLtD2K/iZfE8BMj2wpTfn6Ry8zCYey3mWlKdxIybnV9amrujGRnE0ab6Q16v9D6RlFQLOG6dwqoRKuZy33Uyg8PGdEudZjGbWuKCqqXEp+UKALJHV+k4wWeVH8g5d1n3KyR2TVajVJpCrPhLFmq1Il4G/IUnPe4MvjXqB6CpKkog1+ThWsItPRJPAM+RweFHXq7KfChXsYE7Mmfuly8sDQlvBmQyxZnFHVuiPfCvGHJjpvHy11YlHdOjfgqHRvZbmo30+y0X/oY/yV4YEJ00LL6eJWU4wi7ViY3HP6/VCdRjHoRdr5L/DwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCzzhOFkvyYLNFj2WDcq1YqD4sBy1iCia9QpRH3rjQvMKDwQDYWbi6EdOX0TQ/IYR7UWGj+2pXd6v0t33lYtoKocp/4lUvT3tfBnWZ5KnObi+J2uY2teUqoYkASN7F+GRPVOuMVoVgm05ss8tuMb2dLc9vsx93sDt+XlMTv/2qi5VPwaDtqduKkzwW9lUfn4xIMkTiVvCpe0X2HneD2Bpuao3/U8Rk0uiPfq6TooWaoW3kjsmErhEAs9bA7xuqo1KKY9CdHcFhkSsMhoeaZylZHtzbnoipUlQKSLMdJQiiYZQ0bYL83/Ta9fulr1EERICMFt3GUmtYaZZKHpWSfdJp9" ], "x5t#S256": "wzPVobIrveR1x-PCbjsFGNV-6zn7Rm9KuOWOG4Rk6jE" } }, "IdPKeyCredentialResponse": { "summary": "IdP key credential", "value": { "created": "2016-01-03T18:15:47.000Z", "e": "65537", "kid": "your-key-id", "kty": "RSA", "lastUpdated": "2016-01-03T18:15:47.000Z", "n": "101438407598598116085679865987760095721749307901605456708912786847324207000576780508113360584555007890315805735307890113536927352312915634368993759211767770602174860126854831344273970871509573365292777620005537635317282520456901584213746937262823585533063042033441296629204165064680610660631365266976782082747", "use": "sig", "x5c": [ "MIIDnjCCAoagAwIBAgIGAVG3MN+PMA0GCSqGSIb3DQEBBQUAMIGPMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEDAOBgNVBAMMB2V4YW1wbGUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMTUxMjE4MjIyMjMyWhcNMjUxMjE4MjIyMzMyWjCBjzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRAwDgYDVQQDDAdleGFtcGxlMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtcnyvuVCrsFEKCwHDenS3Ocjed8eWDv3zLtD2K/iZfE8BMj2wpTfn6Ry8zCYey3mWlKdxIybnV9amrujGRnE0ab6Q16v9D6RlFQLOG6dwqoRKuZy33Uyg8PGdEudZjGbWuKCqqXEp+UKALJHV+k4wWeVH8g5d1n3KyR2TVajVJpCrPhLFmq1Il4G/IUnPe4MvjXqB6CpKkog1+ThWsItPRJPAM+RweFHXq7KfChXsYE7Mmfuly8sDQlvBmQyxZnFHVuiPfCvGHJjpvHy11YlHdOjfgqHRvZbmo30+y0X/oY/yV4YEJ00LL6eJWU4wi7ViY3HP6/VCdRjHoRdr5L/DwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCzzhOFkvyYLNFj2WDcq1YqD4sBy1iCia9QpRH3rjQvMKDwQDYWbi6EdOX0TQ/IYR7UWGj+2pXd6v0t33lYtoKocp/4lUvT3tfBnWZ5KnObi+J2uY2teUqoYkASN7F+GRPVOuMVoVgm05ss8tuMb2dLc9vsx93sDt+XlMTv/2qi5VPwaDtqduKkzwW9lUfn4xIMkTiVvCpe0X2HneD2Bpuao3/U8Rk0uiPfq6TooWaoW3kjsmErhEAs9bA7xuqo1KKY9CdHcFhkSsMhoeaZylZHtzbnoipUlQKSLMdJQiiYZQ0bYL83/Ta9fulr1EERICMFt3GUmtYaZZKHpWSfdJp9" ], "x5t#S256": "wzPVobIrveR1x-PCbjsFGNV-6zn7Rm9KuOWOG4Rk6jE" } }, "IdPSigningKeyCredentialResponse": { "summary": "IdP signing key credential", "value": { "created": "2015-12-10T18:56:23.000Z", "expiresAt": "2017-12-10T18:56:22.000Z", "kid": "akm5hvbbevE341ovl0h7", "kty": "RSA", "use": "sig", "x5c": [ "MIIDnjCCAoagAwIBAgIGAVG3MN+PMA0GCSqGSIb3DQEBBQUAMIGPMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEDAOBgNVBAMMB2V4YW1wbGUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMTUxMjE4MjIyMjMyWhcNMjUxMjE4MjIyMzMyWjCBjzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRAwDgYDVQQDDAdleGFtcGxlMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtcnyvuVCrsFEKCwHDenS3Ocjed8eWDv3zLtD2K/iZfE8BMj2wpTfn6Ry8zCYey3mWlKdxIybnV9amrujGRnE0ab6Q16v9D6RlFQLOG6dwqoRKuZy33Uyg8PGdEudZjGbWuKCqqXEp+UKALJHV+k4wWeVH8g5d1n3KyR2TVajVJpCrPhLFmq1Il4G/IUnPe4MvjXqB6CpKkog1+ThWsItPRJPAM+RweFHXq7KfChXsYE7Mmfuly8sDQlvBmQyxZnFHVuiPfCvGHJjpvHy11YlHdOjfgqHRvZbmo30+y0X/oY/yV4YEJ00LL6eJWU4wi7ViY3HP6/VCdRjHoRdr5L/DwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCzzhOFkvyYLNFj2WDcq1YqD4sBy1iCia9QpRH3rjQvMKDwQDYWbi6EdOX0TQ/IYR7UWGj+2pXd6v0t33lYtoKocp/4lUvT3tfBnWZ5KnObi+J2uY2teUqoYkASN7F+GRPVOuMVoVgm05ss8tuMb2dLc9vsx93sDt+XlMTv/2qi5VPwaDtqduKkzwW9lUfn4xIMkTiVvCpe0X2HneD2Bpuao3/U8Rk0uiPfq6TooWaoW3kjsmErhEAs9bA7xuqo1KKY9CdHcFhkSsMhoeaZylZHtzbnoipUlQKSLMdJQiiYZQ0bYL83/Ta9fulr1EERICMFt3GUmtYaZZKHpWSfdJp9" ], "x5t#S256": "wzPVobIrveR1x-PCbjsFGNV-6zn7Rm9KuOWOG4Rk6jE" } }, "IdvExample": { "summary": "Identity Verification (IDV) configuration example", "value": { "authorizeUrl": "https://auth.example.com/oauth/authorize", "configUrl": "https://example.com/config/url", "issuerUrl": "https://auth.example.com/", "jwksUrl": "https://auth.example.com/.well-known/jwks.json", "parUrl": "https://auth.example.com/oauth/par", "privacyPolicyUrl": "https://example.com/legal/privacy", "termsOfUseUrl": "https://example.com/legal/eula", "tokenUrl": "https://auth.example.com/oauth/token" } }, "IncodeIDVResponse": { "summary": "Incode as IdP", "value": { "_links": { "users": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oaf35tu47hnH9mlZ0w6/users" } }, "created": "2025-01-15T20:54:04.000Z", "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oaf35tu47hnH9mlZ0w6/lifecycle/deactivate" }, "id": "0oaf35tu47hnH9mlZ0w6", "lastUpdated": "2025-01-15T20:54:05.000Z", "name": "Incode IdP", "policy": { "maxClockSkew": 0, "provisioning": { "action": "DISABLED", "groups": null, "profileMaster": false }, "subject": { "filter": null, "matchAttribute": null, "matchType": "USERNAME", "userNameTemplate": { "template": "source.userName" } } }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://auth.incode.com/oauth2/authorize" }, "par": { "binding": "HTTP-POST", "url": "https://auth.incode.com/oauth2/par" }, "token": { "binding": "HTTP-POST", "url": "https://auth.incode.com/oauth2/token" } }, "scopes": [ "openid", "profile", "identity_assurance" ], "type": "ID_PROOFING" }, "status": "ACTIVE", "type": "IDV_INCODE" }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "LIMITED_GA" } }, "InlineHookMgmtCreateHTTPRequest": { "summary": "Create an inline hook with HTTP authentication", "value": { "channel": { "config": { "authScheme": { "key": "Authorization", "type": "HEADER", "value": "my-shared-secret" }, "headers": [ { "key": "x-any-key", "value": "my-header-value" } ], "method": "POST", "uri": "https://example.com/tokenHook" }, "type": "HTTP", "version": "1.0.0" }, "name": "Token hook with HTTP authentication", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } }, "InlineHookMgmtCreateHTTPResponse": { "summary": "Inline hook with HTTP authentication response", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" }, "delete": { "hints": { "allow": [ "DELETE" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" } }, "channel": { "config": { "authScheme": { "key": "authorization", "type": "header" }, "headers": [], "method": "POST", "uri": "https://example.com/tokenHook" }, "type": "HTTP", "version": "1.0.0" }, "created": "2024-08-22T21:01:09.000Z", "id": "calb7gacafgwgE7hc5e4", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Token hook with HTTP authentication", "status": "ACTIVE", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } }, "InlineHookMgmtCreateOAuthClientSecretRequest": { "summary": "Create an inline hook with OAuth 2.0 Client Secret", "value": { "channel": { "config": { "authType": "client_secret_post", "clientId": "0oaj43vkrq7wKxZSI5e6", "clientSecret": "b-iATvTu7sIocvhWx95S9kF.....vfZhM6q6khSaojLBejF21cUn5bPm9abi", "headers": [], "method": "POST", "tokenUrl": "https://example.okta.com/oauth2/default/v1/token", "uri": "https://example.com/tokenHook" }, "type": "OAUTH", "version": "1.0.0" }, "name": "Registration hook with OAuth 2.0 Client Secret Post", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } }, "InlineHookMgmtCreateOAuthClientSecretResponse": { "summary": "Inline hook with OAuth 2.0 Client Secret response", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/lifecycle/activate" }, "execute": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/execute" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5" } }, "channel": { "config": { "authScheme": null, "authType": "client_secret_post", "clientId": "0oaj43vkrq7wKxZSI5e6", "headers": [], "method": "POST", "scope": null, "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", "uri": "https://example.com/registrationHook" }, "type": "OAUTH", "version": "1.0.0" }, "created": "2024-08-22T21:01:09.000Z", "id": "calj4fythrqj5Bxol5e5", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Registration hook with OAuth 2.0 Client Secret Post", "status": "ACTIVE", "type": "com.okta.user.pre-registration", "version": "1.0.0" } }, "InlineHookMgmtCreateOAuthPrivateKeyRequest": { "summary": "Create an inline hook with OAuth 2.0 Private Key", "value": { "channel": { "config": { "authType": "private_key_jwt", "clientId": "0oaj43vkrq7wKxZSI5e6", "headers": [ { "key": "x-any-key", "value": "my-header-value" } ], "hookKeyId": "HKYj4ft1a3fjmwZg05e6", "method": "POST", "tokenUrl": "https://example.okta.com/oauth2/default/v1/token", "uri": "https://example.com/tokenHook" }, "type": "OAUTH", "version": "1.0.0" }, "name": "Token hook with OAuth 2.0 Private Key authentication", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } }, "InlineHookMgmtCreateOAuthPrivateKeyResponse": { "summary": "Inline hook with OAuth 2.0 Private Key response", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/lifecycle/activate" }, "execute": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/execute" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6" } }, "channel": { "config": { "authScheme": null, "authType": "private_key_jwt", "clientId": "0oaj43vkrq7wKxZSI5d7", "headers": [], "hookKeyId": "HKYj4ft1a3fjmwZg05d6", "method": "POST", "scope": null, "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", "uri": "https://example.com/tokenHook" }, "created": "2024-08-22T21:01:09.000Z", "type": "OAUTH", "version": "1.0.0" }, "id": "calj4fythrqj5Bxol4ai6", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Token Hook with OAuth 2.0 Private Key JWT", "status": "ACTIVE", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } }, "InlineHookMgmtHTTPexample": { "summary": "An inline hook with HTTP authentication", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" }, "delete": { "hints": { "allow": [ "DELETE" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" } }, "channel": { "config": { "authScheme": { "key": "authorization", "type": "header" }, "headers": [], "method": "POST", "uri": "https://example.com/tokenHook" }, "type": "HTTP", "version": "1.0.0" }, "created": "2024-08-22T21:01:09.000Z", "id": "calb7gacafgwgE7hc5e4", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Token hook with HTTP authentication", "status": "ACTIVE", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } }, "InlineHookMgmtHTTPexampleDeactivate": { "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" }, "delete": { "hints": { "allow": [ "DELETE" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" } }, "channel": { "config": { "authScheme": { "key": "authorization", "type": "header" }, "headers": [], "method": "POST", "uri": "https://example.com/tokenHook" }, "type": "HTTP", "version": "1.0.0" }, "created": "2024-08-22T21:01:09.000Z", "id": "calb7gacafgwgE7hc5e4", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Token hook with HTTP authentication", "status": "INACTIVE", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } }, "InlineHookMgmtOAuthCSPexample": { "summary": "An inline hook example with OAuth 2.0 Client Secret Post", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/lifecycle/activate" }, "execute": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/execute" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5" } }, "channel": { "config": { "authScheme": null, "authType": "client_secret_post", "clientId": "0oaj43vkrq7wKxZSI5e6", "headers": [], "method": "POST", "scope": null, "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", "uri": "https://example.com/registrationHook" }, "type": "OAUTH", "version": "1.0.0" }, "created": "2024-08-22T21:01:09.000Z", "id": "calj4fythrqj5Bxol5e5", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Registration hook with OAuth 2.0 Client Secret Post", "status": "ACTIVE", "type": "com.okta.user.pre-registration", "version": "1.0.0" } }, "InlineHookMgmtOauthPKJexample": { "summary": "An inline hook example with OAuth 2.0 Private Key JWT", "value": { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/lifecycle/activate" }, "execute": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/execute" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6" } }, "channel": { "config": { "authScheme": null, "authType": "private_key_jwt", "clientId": "0oaj43vkrq7wKxZSI5d7", "headers": [], "hookKeyId": "HKYj4ft1a3fjmwZg05d6", "method": "POST", "scope": null, "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", "uri": "https://example.com/tokenHook" }, "created": "2024-08-22T21:01:09.000Z", "type": "OAUTH", "version": "1.0.0" }, "id": "calj4fythrqj5Bxol4ai6", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Token Hook with OAuth 2.0 Private Key JWT", "status": "ACTIVE", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } }, "InlineHookMgmtPutHTTPRequest": { "summary": "Update an inline hook name", "value": { "channel": { "config": { "authScheme": { "key": "Authorization", "type": "HEADER", "value": "my-shared-secret" }, "headers": [ { "key": "x-any-key", "value": "my-header-value" } ], "method": "POST", "uri": "https://example.com/tokenHook" }, "type": "HTTP", "version": "1.0.0" }, "name": "New name token hook with HTTP authentication", "version": "1.0.0" } }, "InlineHookMgmtPutResponse": { "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" }, "delete": { "hints": { "allow": [ "DELETE" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" } }, "channel": { "config": { "authScheme": { "key": "authorization", "type": "header" }, "headers": [], "method": "POST", "uri": "https://example.com/tokenHook" }, "type": "HTTP", "version": "1.0.0" }, "created": "2024-08-22T21:01:09.000Z", "description": "Inline hook response with a new name", "id": "calb7gacafgwgE7hc5e4", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "New name token hook with HTTP authentication", "status": "ACTIVE", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } }, "InlineHookTelephony": { "value": { "_links": { "deactivate": { "hints": { "allow\"": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/inlineHooks/caldpyulr3nbET2du1d7/lifecycle/deactivate" }, "execute": { "hints": { "allow\"": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/inlineHooks/caldpyulr3nbET2du1d7/execute" }, "self": { "href": "https://{yourOktaDomain}/api/v1/inlineHooks/caldpyulr3nbET2du1d7" } }, "channel": { "config": { "authScheme": { "key": "x-telephony-key", "type": "HEADER" }, "headers": [], "method": "POST", "uri": "https://your-external-webservice/sendOtp" }, "type": "HTTP", "version": "1.0.0" }, "created": "2024-03-28T17:30:25.000Z", "id": "caldpyulr3nbET2du1d7", "lastUpdated": "2024-05-07T16:35:18.000Z", "name": "testTelephonyHook", "status": "ACTIVE", "type": "com.okta.telephony.provider", "version": null } }, "InlineHooktMgmtListAllexample": { "summary": "List all inline hooks response", "value": [ { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4/lifecycle/activate" }, "delete": { "hints": { "allow": [ "DELETE" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calb7gacafgwgE7hc5e4" } }, "channel": { "config": { "authScheme": { "key": "authorization", "type": "header" }, "headers": [], "method": "POST", "uri": "https://example.com/tokenHook" }, "type": "HTTP", "version": "1.0.0" }, "created": "2024-08-22T21:01:09.000Z", "id": "calb7gacafgwgE7hc5e4", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Token hook with HTTP authentication", "status": "ACTIVE", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" }, { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/lifecycle/activate" }, "execute": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5/execute" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol5e5" } }, "channel": { "config": { "authScheme": null, "authType": "client_secret_post", "clientId": "0oaj43vkrq7wKxZSI5e6", "headers": [], "method": "POST", "scope": null, "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", "uri": "https://example.com/registrationHook" }, "type": "OAUTH", "version": "1.0.0" }, "created": "2024-08-22T21:01:09.000Z", "id": "calj4fythrqj5Bxol5e5", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Registration hook with OAuth 2.0 Client Secret Post", "status": "ACTIVE", "type": "com.okta.user.pre-registration", "version": "1.0.0" }, { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/lifecycle/activate" }, "execute": { "hints": { "allow": [ "POST" ] }, "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6/execute" }, "self": { "href": "https://subdomain.okta.com/api/v1/inlineHooks/calj4fythrqj5Bxol4ai6" } }, "channel": { "config": { "authScheme": null, "authType": "private_key_jwt", "clientId": "0oaj43vkrq7wKxZSI5d7", "headers": [], "hookKeyId": "HKYj4ft1a3fjmwZg05d6", "method": "POST", "scope": null, "tokenUrl": "https:/subdomain.okta.com/oauth2/default/v1/token\"", "uri": "https://example.com/tokenHook" }, "created": "2024-08-22T21:01:09.000Z", "type": "OAUTH", "version": "1.0.0" }, "id": "calj4fythrqj5Bxol4ai6", "lastUpdated": "2024-09-05T16:06:09.000Z", "name": "Token Hook with OAuth 2.0 Private Key JWT", "status": "ACTIVE", "type": "com.okta.oauth2.tokens.transform", "version": "1.0.0" } ] }, "InterclientTrustMappingResponse": { "summary": "Create an interclient target and allowed app mapping response", "value": [ { "appInstanceId": "0oa8ghelqWXs70qD80g5", "created": "2025-11-25T22:44:06.000Z", "id": "itmahqusSr3v8Kk3B0g5", "lastUpdated": "2025-11-25T22:44:06.000Z", "lastUpdatedBy": "00u102rhXmxEGFKiB0g5", "orgId": "00o102n9p4vX126Gp0g5", "trustedAppInstanceId": "0oa5kw6q51dFckBE70g5" } ] }, "InvalidRotateUse": { "summary": "Invalid use", "value": { "errorCauses": [ { "errorSummary": "Invalid value specified for key 'use' parameter" } ], "errorCode": "E0000001", "errorId": "oaeprak9qKHRlaWiclJ4oPJRQ", "errorLink": "E0000001", "errorSummary": "Api validation failed: rotateKeys" } }, "InvalidWellKnownAppleAppSiteRepresentationError": { "summary": "apple-app-site-association representation contains authsrv", "value": { "errorCauses": [ { "errorSummary": "Content must not include any `authsrv` customization." } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: representation" } }, "InvalidWellKnownArrayTypeError": { "summary": "Invalid content type for assetlinks.json", "value": { "errorCauses": [ { "errorSummary": "Content must be a JSON array of objects." } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: representation" } }, "InvalidWellKnownJsonTypeError": { "summary": "Invalid content type for apple-app-site-association and webauthn", "value": { "errorCauses": [ { "errorSummary": "Content must be a JSON object." } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: representation" } }, "InvalidWellKnownWebauthnRepresentationError": { "summary": "webauthn representation doesn't contain origins", "value": { "errorCauses": [ { "errorSummary": "Content must only contain `origins`." } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: representation" } }, "InvalidWellKnownWebauthnRepresentationOriginStringError": { "summary": "webauthn representation - `origins` must be array of strings", "value": { "errorCauses": [ { "errorSummary": "The `origins` must be an array of strings." } ], "errorCode": "E0000001", "errorId": "sampleiCF-8D5rLW6myqiPItW", "errorLink": "E0000001", "errorSummary": "Api validation failed: representation" } }, "KeyCredentialExample": { "summary": "Key credential example", "value": { "created": "2015-12-10T18:56:23.000Z", "e": "AQAB", "expiresAt": "2017-12-10T18:56:22.000Z", "kid": "SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-FIbm4", "kty": "RSA", "lastUpdated": "2024-08-13T18:26:57.000Z", "n": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", "use": "sig", "x5c": [ "MIIDqDCCApCgAwIBAgIGAVGNQFX5MA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODU1MjJaFw0xNzEyMTAxODU2MjJaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJJjrcnI6cXBiXNq9YDgfYrQe2O5qEHG4MXP8Ue0sMeefFkFEHYHnHUeZCq6WTAGqR+1LFgOl+Eq9We5V+qNlGIfkFkQ3iHGBrIALKqLCd0Et76HicDiegz7j9DtN+lo0hG/gfcw5783L5g5xeQ7zVmCQMkFwoUA0uA3bsfUSrmfORHJL+EMNQT8XIXD8NkG4g6u7ylHVRTLgXbe+W/p04m3EP6l41xl+MhIpBaPxDsyUvcKCNwkZN3aZIin1O9Y4YJuDHxrM64/VtLLp0sC05iawAmfsLunF7rdJAkWUpPn+xkviyNQ3UpvwAYuDr+jKLUdh2reRnm1PezxMIXzBVMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEARnFIjyitrCGbleFr3KeAwdOyeHiRmgeKupX5ZopgXtcseJoToUIinX5DVw2fVZPahqs0Q7/a0wcVnTRpw6946qZCwKd/PvZ1feVuVEA5Ui3+XvHuSH5xLp7NvYG1snNEvlbN3+NDUMlWj2NEbihowUBt9+UxTpQO3+N08q3aZk3hOZ+tHt+1Te7KEEL/4CM28GZ9MY7fSrS7MAgp1+ZXtn+kRlMrXnQ49qBda37brwDRqmSY9PwNMbev3r+9ZHwxr9W5wXW4Ev4C4xngA7RkVoyDbItSUho0I0M0u/LHuppclnXrw97xyO5Z883eIBvPVjfRcxsJxXJ8jx70ATDskw==" ], "x5t#S256\"": "5GOpy9CQVtfvBmu2T8BHvpKE4OGtC3BuS046t7p9pps" } }, "LinkIdPAppUserResponse": { "summary": "Linked IdP user", "value": { "_links": { "idp": { "href": "https://{yourOktaDomain}/api/v1/idps/0oa62b57p7c8PaGpU0h7" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa62b57p7c8PaGpU0h7/users/00ub0oNGTSWTBKOLGLNR" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/00ub0oNGTSWTBKOLGLNR" } }, "created": "2017-03-30T02:19:51.000Z", "externalId": "121749775026145", "id": "00ub0oNGTSWTBKOLGLNR", "lastUpdated": "2017-03-30T02:19:51.000Z" } }, "ListAllAgentPoolUpdatesResponse": { "summary": "List all agent pool updates", "value": [ { "_links": { "self": { "href": "/api/v1/agentPools/poolId1/updates" } }, "agentType": "AD", "agents": { "id": "a533eu8npxdZ60Mvf5s6", "isHidden": false, "isLatestGAedVersion": true, "lastConnection": 1750462090000, "latestGAedVersion": true, "name": "N079-H069", "operationalStatus": "OPERATIONAL", "poolId": "0oa3eu7ekG8tjbD9J5s6", "type": "AD", "updateMessage": "Queued for update.", "updateStatus": "Scheduled", "version": "3.20.0" }, "enabled": true, "id": "poolId1", "name": "testSchedule", "notifyAdmin": true, "schedule": { "cron": "0 1 * * THU", "duration": 420, "timezone": "America/Los_Angeles" }, "status": "Scheduled", "targetVersion": "3.20.0" } ] }, "ListAllAgentPoolsResponse": { "summary": "List all agent pools", "value": [ { "_links": { "self": { "href": "/api/v1/agentPools/poolId1" } }, "agents": { "active": true, "errorState": true, "id": "agentId1", "indicator": "green", "isHidden": false, "isLatestGAedVersion": false, "lastConnection": 1628263766000, "message": "Agent connection is live", "name": "WIN-region1A-dc", "operationalStatus": "OPERATIONAL", "poolId": "poolId1", "state": "ACTIVE", "supportAutoUpdate": true, "updateMessage": "Queued for update.", "upgradeRequired": false, "version": "3.18.0" }, "disruptedAgents": 0, "id": "poolId1", "inactiveAgents": 1, "name": "region1A.dc", "operationalStatus": "OPERATIONAL", "type": "AD" } ] }, "ListAllKeyCredentialsExample": { "summary": "List all key credentials example", "value": [ { "created": "2015-12-10T18:56:23.000Z", "e": "AQAB", "expiresAt": "2017-12-10T18:56:22.000Z", "kid": "SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-FIbm4", "kty": "RSA", "lastUpdated": "2024-08-13T18:26:57.000Z", "n": "mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ", "use": "sig", "x5c": [ "MIIDqDCCApCgAwIBAgIGAVGNQFX5MA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODU1MjJaFw0xNzEyMTAxODU2MjJaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJJjrcnI6cXBiXNq9YDgfYrQe2O5qEHG4MXP8Ue0sMeefFkFEHYHnHUeZCq6WTAGqR+1LFgOl+Eq9We5V+qNlGIfkFkQ3iHGBrIALKqLCd0Et76HicDiegz7j9DtN+lo0hG/gfcw5783L5g5xeQ7zVmCQMkFwoUA0uA3bsfUSrmfORHJL+EMNQT8XIXD8NkG4g6u7ylHVRTLgXbe+W/p04m3EP6l41xl+MhIpBaPxDsyUvcKCNwkZN3aZIin1O9Y4YJuDHxrM64/VtLLp0sC05iawAmfsLunF7rdJAkWUpPn+xkviyNQ3UpvwAYuDr+jKLUdh2reRnm1PezxMIXzBVMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEARnFIjyitrCGbleFr3KeAwdOyeHiRmgeKupX5ZopgXtcseJoToUIinX5DVw2fVZPahqs0Q7/a0wcVnTRpw6946qZCwKd/PvZ1feVuVEA5Ui3+XvHuSH5xLp7NvYG1snNEvlbN3+NDUMlWj2NEbihowUBt9+UxTpQO3+N08q3aZk3hOZ+tHt+1Te7KEEL/4CM28GZ9MY7fSrS7MAgp1+ZXtn+kRlMrXnQ49qBda37brwDRqmSY9PwNMbev3r+9ZHwxr9W5wXW4Ev4C4xngA7RkVoyDbItSUho0I0M0u/LHuppclnXrw97xyO5Z883eIBvPVjfRcxsJxXJ8jx70ATDskw==" ], "x5t#S256\"": "5GOpy9CQVtfvBmu2T8BHvpKE4OGtC3BuS046t7p9pps" }, { "created": "2015-12-10T18:55:35.000Z", "e": "AQAB", "expiresAt": "2045-01-23T02:15:23.000Z", "kid": "mXtzOtml09Dg1ZCeKxTRBo3KrQuBWFkJ5oxhVagjTzo", "kty": "RSA", "lastUpdated": "2024-08-13T18:26:57.000Z", "n": "htbi5H5MN_oYaKcZ8vlWRZn2oTrPY0v8_2Br_VZPJgJ57dCgguq5dDk1Me_ax-B3kjBPdXcW8wEoUFaU30spyVeQjZrdqsSvF0nMW4OzrMOIqrGLwCrAoDBS8tutfk5Y7qc-5xABzxgu4BjgSK5nWXbCt_UR0DzVTknotmMGeT8tAej8F6GAphLa0YhIxWT7Jy-y_pdANsiUPRiZBoLueGI0rrCqgYHIQVjNoj4-si105KCXbQuyYM9_Cd-dyyu5KJ4Ic0cOW61gpx4pnecMgSy8OX57FEd06W2hExBd49ah6jra2KFMeOGe3rkIXirdkofl1mBgeQ77ruKO1wW9Qw", "use": "sig", "x5c": [ "MIIDqDCCApCgAwIBAgIGAUsUkouzMA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTAxMjMwMjE0MjNaFw00NTAxMjMwMjE1MjNaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKhmkmKsu3FYeBiJg44aN6Ah3g9gof1cytXJVMnblDUWpLfe/FMUQCssh8Y8NCYRri5jni4efBgk6B3SkC7ymqsOXILIEHSwUYWnAaqDOTxO101mHzryowu1+0PldRNoyTthahpprvAPYlTin9zrDTqFT+WY/zwoaN8H+CfixlW1nM85qF18zYYekkW50MSoHPcfJKe2ywIhPXTYTSBEPcHh8dQEjBrZn7A4qOoDnfOXll8OL7j2O6EVyTtHA0tLJHVLpwI4gSPsXFwEnHltjN57odwYe9yds0BbM/YG9i+am1+3cmZ6Uyd16mLGclrr05o9BHcEZ4ZctV2hr6whbRsCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEAnNlF27gRmhGTQ+GRAvbvYToFRgsIbBAPvRqB2LmEIiQ6UJd602w6uP1sv/zEzBYg4SnMLuVyWgOJ6d71dCvXdIO9mgAq6BaEPjlo0WhGyt+zGrpkMnIX5EwRa64kHydcPRHNA607wVYA96sJdyNJEMzBvjY9fJnfevzzDCN3NWpMS2T6rk6HP5IziI1VuFWY2OUC1kbCqLj1dUgp8koe3ftLL55ZpkAocnVMnrzBveNjgAOAiKTMcyS0bhESph9aVWvuHVZSfTnUjnTPb/4jA2YlB3ED+qaU3aqHwft1KXwZskNXBKXy7lyC+CMoeB3/ncFhSg/UllBooPPS3wYlNA==" ], "x5t#S256\"": "7CCyXWwKzH4P6PoBP91B1S_iIZVzuGffVnUXu-BTYQQ" } ] }, "ListAllKeysResponse": { "summary": "List all keys response example", "value": [ { "created": "2022-08-22T16:34:33.000Z", "id": "HKY1i2htmXF5UNQhL0g4", "isUsed": "true", "keyId": "bb5bed7d-6e4d-488f-9c86-59b93a2bb3fb", "lastUpdated": "2022-08-22T16:34:33.000Z", "name": "My new key" }, { "created": "2022-08-31T18:09:58.000Z", "id": "HKY1p7jWLndGQV9M60g4", "isUsed": "false", "keyId": "7fbc27fd-e3df-4522-86bf-1930110256ad", "lastUpdated": "2022-08-31T18:09:58.000Z", "name": "Test key" } ] }, "ListAppGrantsEx": { "summary": "List all app grants example", "value": [ { "_embedded": { "scope": { "id": "okta.users.read" } }, "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/{appId}", "title": "Application name" }, "client": { "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", "title": "Client name" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/apps/{appId}/grants/oag91n9ruw3dsaXzP0h6" } }, "clientId": "{clientId}", "created": "2023-02-21T16:54:00.000Z", "createdBy": { "id": "00u6eltha0nrSc47i0h7", "type": "User" }, "id": "oag91n9ruw3dsaXzP0h6", "issuer": "{yourOktaDomain}", "lastUpdated": "2023-02-21T16:54:00.000Z", "scopeId": "okta.users.read", "source": "ADMIN", "status": "ACTIVE" }, { "_embedded": { "scope": { "id": "okta.apps.manage" } }, "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/{appId}", "title": "Application name" }, "client": { "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", "title": "Client name" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/apps/{appId}/grants/oaghm3sh9ukdkvDmO0h6" } }, "clientId": "{clientId}", "created": "2023-02-03T21:57:49.000Z", "createdBy": { "id": "00u6eltha0nrSc47i0h7", "type": "User" }, "id": "oaghm3sh9ukdkvDmO0h6", "issuer": "{yourOktaDomain}", "lastUpdated": "2023-02-03T21:57:49.000Z", "scopeId": "okta.apps.manage", "source": "ADMIN", "status": "ACTIVE" } ] }, "ListAppLinks": { "value": [ { "appAssignmentId": "0ua3omz7weMMMQJERBKY", "appInstanceId": "0oa3omz2i9XRNSRIHBZO", "appName": "google", "credentialsSetup": false, "hidden": false, "id": "00ub0oNGTSWTBKOLGLNR", "label": "Google Apps Mail", "linkUrl": "https://{yourOktaDomain}/home/google/0oa3omz2i9XRNSRIHBZO/50", "logoUrl": "https://{yourOktaDomain}/img/logos/google-mail.png", "sortOrder": 0 }, { "appAssignmentId": "0ua3omz7weMMMQJERBKY", "appInstanceId": "0oa3omz2i9XRNSRIHBZO", "appName": "google", "credentialsSetup": false, "hidden": false, "id": "00ub0oNGTSWTBKOLGLNR", "label": "Google Apps Calendar", "linkUrl": "https://{yourOktaDomain}/home/google/0oa3omz2i9XRNSRIHBZO/54", "logoUrl": "https://{yourOktaDomain}/img/logos/google-calendar.png", "sortOrder": 1 }, { "appAssignmentId": "0ua3omx46lYEZLPPRWBO", "appInstanceId": "0oa3ompioiQCSTOYXVBK", "appName": "boxnet", "credentialsSetup": false, "hidden": false, "id": "00ub0oNGTSWTBKOLGLNR", "label": "Box", "linkUrl": "https://{yourOktaDomain}/home/boxnet/0oa3ompioiQCSTOYXVBK/72", "logoUrl": "https://{yourOktaDomain}/img/logos/box.png", "sortOrder": 3 }, { "appAssignmentId": "0ua173qgj5VAVOBQMCVB", "appInstanceId": "0oa12ecnxtBQMKOXJSMF", "appName": "salesforce", "credentialsSetup": true, "hidden": false, "id": "00ub0oNGTSWTBKOLGLNR", "label": "Salesforce.com", "linkUrl": "https://{yourOktaDomain}/home/salesforce/0oa12ecnxtBQMKOXJSMF/46", "logoUrl": "https://{yourOktaDomain}/img/logos/salesforce_logo.png", "sortOrder": 2 } ] }, "ListAppServiceAccounts": { "summary": "List app service accounts", "value": [ { "containerGlobalName": "salesforce", "containerInstanceName": "salesforce-1", "containerOrn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:salesforce:0oa1gjh63g214q0Hq0g4", "created": "2024-04-04T15:56:05.000Z", "description": "This is for accessing salesforce Prod-1", "id": "a747a818-a4c4-4446-8a87-704216495a08", "lastUpdated": "2024-04-05T18:15:44.000Z", "name": "salesforce Prod-1 account", "ownerGroupIds": [ "00g57qp78yZT2XBA40g7" ], "ownerUserIds": [ "00u11s48P9zGW8yqm0g5" ], "status": "NO_ISSUES", "statusDetail": "ROTATED", "username": "testuser-salesforce-1@example.com" }, { "containerGlobalName": "salesforce", "containerInstanceName": "salesforce-5", "containerOrn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:salesforce:0oa1gjh63g214q0Hq0g4", "created": "2024-04-04T15:56:05.000Z", "description": "This is for accessing salesforce Prod-5", "id": "a747a818-a4c4-4446-8a87-704216495a09", "lastUpdated": "2024-04-05T18:15:44.000Z", "name": "salesforce Prod-5 account", "ownerGroupIds": [ "00g57qp78yZT2XBA40g7" ], "ownerUserIds": [ "00u11s48P9zGW8yqm0g5" ], "status": "NO_ISSUES", "statusDetail": "ROTATED", "username": "testuser-salesforce-5@example.com" } ] }, "ListAssocAuthServerResponse": { "summary": "List associated authorization servers", "value": [ { "_links": { "self": { "hints": { "allow": [ "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" } }, "audiences": [ "https://api.resource.com" ], "created": "2023-05-17T22:25:57.000Z", "credentials": { "signing": { "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", "lastRotated": "2023-05-17T22:25:57.000Z", "nextRotation": "2023-08-15T22:25:57.000Z", "rotationMode": "DYNAMIC", "use": "sig" } }, "description": "Sample Authorization Server description", "id": "{authorizationServerId}", "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", "issuerMode": "CUSTOM_URL", "lastUpdated": "2023-05-17T22:25:57.000Z", "name": "Sample Authorization Server", "status": "ACTIVE" } ] }, "ListAuthServersResponse": { "summary": "List all custom authorization servers in your org", "value": [ { "_links": { "claims": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims" }, "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/lifecycle/deactivate" }, "metadata": [ { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/oauth-authorization-server", "name": "oauth-authorization-server" }, { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/{authorizationServerId}/.well-known/openid-configuration", "name": "openid-configuration" } ], "policies": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies" }, "rotateKey": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/lifecycle/keyRotate" }, "scopes": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes" }, "self": { "hints": { "allow": [ "GET", "DELETE", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}" } }, "audiences": [ "https://api.resource.com" ], "created": "2023-05-17T22:25:57.000Z", "credentials": { "signing": { "kid": "WYQxoK4XAwGFn5Zw5AzLxFvqEKLP79BbsKmWeuc5TB4", "lastRotated": "2023-05-17T22:25:57.000Z", "nextRotation": "2023-08-15T22:25:57.000Z", "rotationMode": "AUTO" } }, "description": "Sample Authorization Server description", "id": "{authorizationServerId}", "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", "issuerMode": "ORG_URL", "lastUpdated": "2023-05-17T22:25:57.000Z", "name": "Sample Authorization Server", "status": "ACTIVE" } ] }, "ListAuthorizationServerKeys": { "summary": "All credential keys", "value": [ { "_links": { "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc" } }, "alg": "RS256", "e": "AQAB", "kid": "RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc", "kty": "RSA", "n": "g0MirhrysJMPm_wK45jvMbbyanfhl-jmTBv0o69GeifPaISaXGv8LKn3-CyJvUJcjjeHE17KtumJWVxUDRzFqtIMZ1ctCZyIAuWO0n LKilg7_EIDXJrS8k14biqkPO1lXGFwtjo3zLHeFSLw6sWf-CEN9zv6Ff3IAXb-RMYpfh-bVrxIgWsWCxjLW-UKI3la-gs0nWHH2PJr5HLJuI JIOL5HLJuIJIOLWahqTnm_r1LSCSYr6N4C-fh--w2_BW8DzTHalBYe76bNr0d7AqtR4tGazmrvrc79Wa2bjyxmhhN1u9jSaZQqq-3VZEod8q3, WHH2PJ5v1LoXniJQ4a2W8nDVqb6h4E8MUKYOpljTfQ", "status": "ACTIVE", "use": "sig" }, { "_links": { "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo" } }, "alg": "RS256", "e": "AQAB", "kid": "Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo", "kty": "RSA", "n": "l1hZ_g2sgBE3oHvu34T-5XP18FYJWgtul_nRNg-5xra5ySkaXEOJUDRERUG0HrR42uqf9jYrUTwg9fp-SqqNIdHRaN8EwRSDRsKAwK 3 HIJ2NJfgmrrO2ABkeyUq6rzHxAumiKv1iLFpSawSIiTEBJERtUCDcjbbqyHVFuivIFgH8L37 - XDIDb0XG - R8DOoOHLJPTpsgH - rJe M5w96VIRZInsGC5OGWkFdtgk6OkbvVd7_TXcxLCpWeg1vlbmX - 0 TmG5yjSj7ek05txcpxIqYu - 7 FIGT0KKvXge_BOSEUlJpBhLKU28 OtsOnmc3NLIGXB - GeDiUZiBYQdPR - myB4ZoQ", "status": "NEXT", "use": "sig" }, { "_links": { "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/h5Sr3LXcpQiQlAUVPdhrdLFoIvkhRTAVs_h39bQnxlU" } }, "alg": "RS256", "e": "AQAB", "kid": "h5Sr3LXcpQiQlAUVPdhrdLFoIvkhRTAVs_h39bQnxlU", "kty": "RSA", "n": "lC4ehVB6W0OCtNPnz8udYH9Ao83B6EKnHA5eTcMOap_lQZ-nKtS1lZwBj4wXRVc1XmS0d2OQFA1VMQ-dHLDE3CiGfsGqWbaiZFdW7U GLO1nAwfDdH6xp3xwpKOMewDXbAHJlXdYYAe2ap - CE9c5WLTUBU6JROuWcorHCNJisj1aExyiY5t3JQQVGpBz2oUIHo7NRzQoKimvp dMvMzcYnTlk1dhlG11b1GTkBclprm1BmOP7Ltjd7aEumOJWS67nKcAZzl48Zyg5KtV11V9F9dkGt25qHauqFKL7w3wu - DYhT0hmyFc wn - tXS6e6HQbfHhR_MQxysLtDGOk2ViWv8AQ", "status": "EXPIRED", "use": "sig" } ] }, "ListAuthorizationServerPolicies": { "summary": "List authorization server policies", "value": [ { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies/00palyaappA22DPkj0h7/lifecycle/deactivate" }, "rules": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies/00palyaappA22DPkj0h7/rules" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/policies/00palyaappA22DPkj0h7" } }, "conditions": { "clients": { "include": [ "ALL_CLIENTS" ] } }, "created": "2017-05-26T19:43:53.000Z", "description": "Vendor2 policy description", "id": "00palyaappA22DPkj0h7", "lastUpdated": "2017-06-07T15:28:17.000Z", "name": "Vendor2 Policy", "priority": 1, "status": "ACTIVE", "system": false, "type": "OAUTH_AUTHORIZATION_POLICY" } ] }, "ListAuthorizationServerPolicyRules": { "summary": "List authorization server policy rules", "value": [ { "_links": { "self": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/0prbsjfyl01zfSZ9K0h7/lifecycle/deactivate" }, "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/0prbsjfyl01zfSZ9K0h7" } }, "actions": { "token": { "accessTokenLifetimeMinutes": 60, "inlineHook": { "id": "cal4egvp1mbMldrYN0g7" }, "refreshTokenLifetimeMinutes": 0, "refreshTokenWindowMinutes": 10080 } }, "conditions": { "grantTypes": { "include": [ "implicit", "client_credentials", "authorization_code", "password" ] }, "people": { "groups": { "exclude": [], "include": [ "EVERYONE" ] }, "users": { "exclude": [], "include": [] } }, "scopes": { "include": [ "*" ] } }, "created": "2017-08-25T16:57:02.000Z", "id": "0prbsjfyl01zfSZ9K0h7", "lastUpdated": "2017-08-30T14:51:05.000Z", "name": "Default Policy Rule", "priority": 1, "status": "ACTIVE", "system": false, "type": "RESOURCE_ACCESS" } ] }, "ListBasicSMTPServer": { "summary": "List containing basic authentication SMTP server", "value": { "email-servers": [ { "alias": "CustomServer1", "authType": "BASIC_SMTP_AUTH", "enabled": true, "host": "smtp.example.com", "id": "ces7n3u7sSohfoaou0g1", "port": 587, "username": "user@example.com" } ] } }, "ListBrandsResponse": { "value": [ { "_links": { "emailDomain": { "hints": { "allow": [ "GET", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/email-domains/OeD114iNkrcN6aR680g4" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4" }, "themes": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/bnd114iNkrcN6aR680g4/themes" } }, "agreeToCustomPrivacyPolicy": false, "customPrivacyPolicyUrl": null, "defaultApp": { "appInstanceId": "0oa114iNkrcN6aR680g4", "appLinkName": null, "classicApplicationUri": null }, "emailDomainId": "OeD114iNkrcN6aR680g4", "id": "bnd114iNkrcN6aR680g4", "isDefault": true, "locale": "en", "name": "Okta Default", "removePoweredByOkta": false } ] }, "ListClientsResponse": { "summary": "List all client resources for which an authorization server has tokens", "value": [ { "_links": { "client": { "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", "title": "My Web App" }, "tokens": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/clients/{clientId}/tokens" } }, "client_id": "{clientId}", "client_name": "My Web App", "client_uri": "null,", "logo_uri": "null," } ] }, "ListCustomTokenClaimsResponse": { "summary": "List all custom token claims for an authorization server", "value": [ { "_links": { "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/claims/{claimId}" } }, "alwaysIncludeInToken": true, "apiResourceId": null, "claimType": "RESOURCE", "conditions": { "scopes": [ "profile" ] }, "id": "{claimId}", "name": "sub", "status": "ACTIVE", "system": true, "value": "(appuser != null) ? appuser.userName : app.clientId", "valueType": "EXPRESSION" } ] }, "ListEmailCustomizationResponse": { "value": [ { "_links": { "preview": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4/preview" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel11u6DqUiMbQkpl0g4" }, "template": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" }, "test": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" } }, "body": "
Hello, ${user.profile.firstName}. Click here to activate your account.", "created": "2021-11-09T20:38:10.000Z", "id": "oel11u6DqUiMbQkpl0g4", "isDefault": true, "language": "en", "lastUpdated": "2021-11-11T20:38:10.000Z", "subject": "Welcome to ${org.name}!" } ] }, "ListEmailTemplateResponse": { "value": [ { "_embedded": { "customizationCount": 0, "settings": { "_links": { "self": { "hints": { "allow": [ "GET", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" }, "template": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" } }, "recipients": "ALL_USERS" } }, "_links": { "customizations": { "hints": { "allow": [ "GET", "POST", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations" }, "defaultContent": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" }, "settings": { "hints": { "allow": [ "GET", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/settings" }, "test": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" } }, "name": "UserActivation" } ] }, "ListFactorsResults": { "summary": "List of enrolled factors for the specified user", "value": [ { "_links": { "questions": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/questions" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ufs2bysphxKODSZKWVCT" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2014-04-15T18:10:06.000Z", "factorType": "question", "id": "ufs2bysphxKODSZKWVCT", "lastUpdated": "2014-04-15T18:10:06.000Z", "profile": { "question": "favorite_art_piece", "questionText": "What is your favorite piece of art?" }, "provider": "OKTA", "status": "ACTIVE", "vendorName": "OKTA" }, { "_embedded": { "activation": { "encoding": "base32", "keyLength": 16, "sharedSecret": "HE64TMLL2IUZW2ZLB", "timeStep": 30 } }, "_links": { "next": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf2gsyictRQDSGTDZE/lifecycle/activate", "name": "activate" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/ostf2gsyictRQDSGTDZE" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" } }, "created": "2014-06-27T20:27:33.000Z", "factorType": "token:software:totp", "id": "ostf2gsyictRQDSGTDZE", "lastUpdated": "2014-06-27T20:27:33.000Z", "profile": { "credentialId": "dade.murphy@example.com" }, "provider": "OKTA", "status": "PENDING_ACTIVATION" }, { "_links": { "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms2gt8gzgEBPUWBIFHN" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL" }, "verify": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00u15s1KDETTQMQYABRL/factors/sms2gt8gzgEBPUWBIFHN/verify" } }, "created": "2014-06-27T20:27:26.000Z", "factorType": "sms", "id": "sms2gt8gzgEBPUWBIFHN", "lastUpdated": "2014-06-27T20:27:26.000Z", "profile": { "phoneNumber": "+1-555-415-1337" }, "provider": "OKTA", "status": "ACTIVE" } ] }, "ListFeatureDependenciesResponse": { "summary": "List all dependencies for a feature", "value": [ { "_links": { "dependencies": { "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies" }, "dependents": { "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents" }, "self": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7" } }, "description": "Example feature description", "id": "ftrZooGoT8b41iWRiQs7", "name": "Example feature name", "stage": { "state": "OPEN", "value": "EA" }, "status": "ENABLED", "type": "self-service" } ] }, "ListFeatureDependentsResponse": { "summary": "List all feature dependents for the specified feature", "value": [ { "_links": { "dependencies": { "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies" }, "dependents": { "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents" }, "self": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7" } }, "description": "Example feature description", "id": "ftrZooGoT8b41iWRiQs7", "name": "Example feature name", "stage": { "state": "OPEN", "value": "EA" }, "status": "ENABLED", "type": "self-service" } ] }, "ListFeaturesResponse": { "summary": "List all self-service features for your org", "value": [ { "_links": { "dependencies": { "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependencies" }, "dependents": { "href": "https://{yourOktaDomain}/api/v1/features/ftrlBDFcGwYP2epXCGYn/dependents" }, "self": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/features/ftrZooGoT8b41iWRiQs7" } }, "description": "Example feature description", "id": "ftrZooGoT8b41iWRiQs7", "name": "Example feature name", "stage": { "state": "CLOSED", "value": "BETA" }, "status": "DISABLED", "type": "self-service" } ] }, "ListGroupPushMappingsResponse_Example": { "value": [ { "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" }, "sourceGroup": { "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" }, "targetGroup": { "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" } }, "created": "2025-01-01T00:00:00Z", "errorSummary": "", "id": "gPm00000000000000000", "lastPush": "2025-01-01T00:00:00Z", "lastUpdated": "2025-01-01T00:00:00Z", "sourceGroupId": "00g00000000000000000", "status": "ACTIVE", "targetGroupId": "00g00000000000000001" }, { "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" }, "sourceGroup": { "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000002" }, "targetGroup": { "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000003" } }, "created": "2025-01-02T00:00:00Z", "errorSummary": "", "id": "gPm00000000000000001", "lastPush": "2025-01-02T00:00:00Z", "lastUpdated": "2025-01-02T00:00:00Z", "sourceGroupId": "00g00000000000000002", "status": "INACTIVE", "targetGroupId": "00g00000000000000003" } ] }, "ListGroupPushMappingsResponse_ExampleWithActiveFilter": { "value": [ { "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/0oa00000000000000000" }, "sourceGroup": { "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000000" }, "targetGroup": { "href": "https://{yourOktaDomain}/api/v1/groups/00g00000000000000001" } }, "created": "2025-01-01T00:00:00Z", "errorSummary": "", "id": "gPm00000000000000000", "lastPush": "2025-01-01T00:00:00Z", "lastUpdated": "2025-01-01T00:00:00Z", "sourceGroupId": "00g00000000000000000", "status": "ACTIVE", "targetGroupId": "00g00000000000000001" } ] }, "ListIdPUsersResponse": { "summary": "List of linked IdP users", "value": [ { "_links": { "idp": { "href": "https://{yourOktaDomain}/api/v1/idps/0oa4lb6lbtmH355Hx0h7" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa4lb6lbtmH355Hx0h7/users/00u5cl9lo7nMjHjPr0h7" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/00u5cl9lo7nMjHjPr0h7" } }, "created": "2015-11-03T19:10:11.000Z", "externalId": "109912936038778", "id": "00u5cl9lo7nMjHjPr0h7", "lastUpdated": "2015-11-03T19:11:49.000Z", "profile": { "displayName": "Carol Johnson", "email": "carol_johnson@tfbnw.net", "firstName": "Carol", "lastName": "Johnson", "middleName": "Lee", "profile": "https://www.facebook.com/app_scoped_user_id/109912936038778/" } } ] }, "ListInterclientAllowedAppsResponse": { "summary": "List interclient allowed apps example", "value": [ "0oa1elyw9EAkUNUrW0g5", "0oa5mihmA6vMpXcm50g5", "0oa89ks1irGAcYwXw0g5" ] }, "ListInterclientTargetAppsResponse": { "summary": "List interclient target apps", "value": [ "0oa1elyw9EAkUNUrW0g5", "0oa5mihmA6vMpXcm50g5", "0oa89ks1irGAcYwXw0g5" ] }, "ListLinkedObjects": { "summary": "List all linked object definitions", "value": [ { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/meta/schemas/user/linkedObjects/manager" } }, "associated": { "description": "Subordinate link property", "name": "subordinate", "title": "subordinate", "type": "USER" }, "primary": { "description": "Manager link property", "name": "manager", "title": "manager", "type": "USER" } } ] }, "ListLogs": { "summary": "List all System Log events", "value": [ { "actor": { "alternateId": "john.doe@example.com", "detailEntry": null, "displayName": "John Doe", "id": "00uttidj01jqL21aM1d6", "type": "User" }, "authenticationContext": { "authenticationProvider": null, "authenticationStep": 0, "credentialProvider": null, "credentialType": null, "externalSessionId": "idxBager62CSveUkTxvgRtonA", "interface": null, "issuer": null, "rootSessionId": "idxBager62CSveUkTxvgRtonA" }, "client": { "device": "Computer", "geographicalContext": { "city": "New York", "country": "United States", "geolocation": { "lat": 40.3157, "lon": -74.01 }, "postalCode": 10013, "state": "New York" }, "id": null, "ipAddress": "10.0.0.1", "userAgent": { "browser": "CHROME", "os": "Mac OS X", "rawUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36" }, "zone": null }, "debugContext": { "debugData": { "requestId": "ab609228fe84ce59cdcbfa690bcce016", "requestUri": "/idp/idx/authenticators/poll", "url": "/idp/idx/authenticators/poll" } }, "device": { "device_integrator": null, "disk_encryption_type": "ALL_INTERNAL_VOLUMES", "id": "guofdhyjex1feOgbN1d9", "jailbreak": null, "managed": false, "name": "Mac15,6", "os_platform": "OSX", "os_version": "14.6.0", "registered": true, "screen_lock_type": "BIOMETRIC", "secure_hardware_present": true }, "displayMessage": "User login to Okta", "eventType": "user.session.start", "legacyEventType": "core.user_auth.login_success", "outcome": { "reason": null, "result": "SUCCESS" }, "published": "2024-08-13T15:58:20.353Z", "request": { "ipChain": [ { "geographicalContext": { "city": "New York", "country": "United States", "geolocation": { "lat": 40.3157, "lon": -74.01 }, "postalCode": 10013, "state": "New York" }, "ip": "10.0.0.1", "source": null, "version": "V4" } ] }, "securityContext": { "asNumber": 394089, "asOrg": "ASN 0000", "domain": null, "isProxy": false, "isp": "google" }, "severity": "INFO", "target": [ { "alternateId": "unknown", "detailEntry": null, "displayName": "Okta Verify", "id": "pfdfdhyjf0HMbkP2e1d7", "type": "AuthenticatorEnrollment" }, { "alternateId": "Okta Admin Console", "detailEntry": null, "displayName": "Okta Admin Console", "id": "0oatxlef9sQvvqInq5d6", "type": "AppInstance" } ], "transaction": { "detail": null, "id": "ab609228fe84ce59cdcbfa690bgce016", "type": "WEB" }, "uuid": "dc9fd3c0-598c-11ef-8478-2b7584bf8d5a", "version": 0 } ] }, "ListLogsWithAdditionalSecurityContext": { "summary": "List all System Log events with more security context", "value": { "actor": { "alternateId": "john.doe@example.com", "detailEntry": null, "displayName": "John Doe", "id": "00uttidj01jqL21aM1d6", "type": "User" }, "authenticationContext": { "authenticationProvider": null, "authenticationStep": 0, "credentialProvider": null, "credentialType": null, "externalSessionId": "idxBager62CSveUkTxvgRtonA", "interface": null, "issuer": null, "rootSessionId": "idxBager62CSveUkTxvgRtonA" }, "client": { "device": "Computer", "geographicalContext": { "city": "New York", "country": "United States", "geolocation": { "lat": 40.3157, "lon": -74.01 }, "postalCode": 10013, "state": "New York" }, "id": null, "ipAddress": "10.0.0.1", "userAgent": { "browser": "CHROME", "os": "Mac OS X", "rawUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36" }, "zone": null }, "debugContext": { "debugData": { "requestId": "ab609228fe84ce59cdcbfa690bcce016", "requestUri": "/idp/idx/authenticators/poll", "url": "/idp/idx/authenticators/poll" } }, "device": { "device_integrator": null, "disk_encryption_type": "ALL_INTERNAL_VOLUMES", "id": "guofdhyjex1feOgbN1d9", "jailbreak": null, "managed": false, "name": "Mac15,6", "os_platform": "OSX", "os_version": "14.6.0", "registered": true, "screen_lock_type": "BIOMETRIC", "secure_hardware_present": true }, "displayMessage": "User login to Okta", "eventType": "user.session.start", "legacyEventType": "core.user_auth.login_success", "outcome": { "reason": null, "result": "SUCCESS" }, "published": "2024-08-13T15:58:20.353Z", "request": { "ipChain": [ { "geographicalContext": { "city": "New York", "country": "United States", "geolocation": { "lat": 40.3157, "lon": -74.01 }, "postalCode": 10013, "state": "New York" }, "ip": "10.0.0.1", "ipDetails": { "asNumber": 394089, "asOrg": "ASN 0000", "isp": "google" }, "source": null, "version": "V4" } ] }, "securityContext": { "asNumber": 394089, "asOrg": "ASN 0000", "botProtection": { "level": "LOW" }, "domain": null, "ipDetails": { "asNumber": 394089, "asOrg": "ASN 0000", "isp": "google" }, "isProxy": false, "isp": "google", "risk": { "detectionName": "Suspected Session Hijacking", "level": "HIGH", "reasons": [ "Anomalous Device" ] }, "userBehaviors": [ { "id": "bhv3pcdHYo3rVDL0w0g4", "name": "New Device", "result": "NEGATIVE" }, { "id": "bhvexm4UkQc71MgEw0g4", "name": "New Geo-Location", "result": "POSITIVE" } ] }, "severity": "INFO", "target": [ { "alternateId": "unknown", "detailEntry": null, "displayName": "Okta Verify", "id": "pfdfdhyjf0HMbkP2e1d7", "type": "AuthenticatorEnrollment" }, { "alternateId": "Okta Admin Console", "detailEntry": null, "displayName": "Okta Admin Console", "id": "0oatxlef9sQvvqInq5d6", "type": "AppInstance" } ], "transaction": { "detail": null, "id": "ab609228fe84ce59cdcbfa690bgce016", "type": "WEB" }, "uuid": "dc9fd3c0-598c-11ef-8478-2b7584bf8d5a", "version": 0 }, "x-okta-lifecycle": { "isGenerallyAvailable": true, "lifecycle": "GA" } }, "ListMappingsResponse": { "summary": "List all profile mappings response", "value": [ { "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/mappings/prm1k48weFSOnEUnw0g4" } }, "id": "prm1k47ghydIQOTBW0g4", "source": { "_links": { "schema": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscsbePhQ3yqt4cVv0g3" }, "self": { "href": "https://{yourOktaDomain}/api/v1/meta/types/user/otysbePhQ3yqt4cVv0g3" } }, "id": "otysbePhQ3yqt4cVv0g3", "name": "user", "type": "user" }, "target": { "_links": { "schema": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/apps/0oa1qmn4LZQQEH0wZ0g4/default" }, "self": { "href": "https://{yourOktaDomain}/api/v1/apps/0oa1qmn4LZQQEH0wZ0g4" } }, "id": "0oa1qmn4LZQQEH0wZ0g4", "name": "okta_org2org", "type": "appuser" } } ] }, "ListOAuth2ResourceServerJsonWebKeys": { "summary": "All OAuth2 Resource Server JSON Web Keys", "value": [ { "_links": { "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/resourceservercredentials/keys/RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc" } }, "created": "2023-04-06T21:32:33.000Z", "e": "AQAB", "id": "apk40n33xfjbPaf6D0g5", "kid": "RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc", "kty": "RSA", "lastUpdated": "2023-04-06T21:32:33.000Z", "n": "g0MirhrysJMPm_wK45jvMbbyanfhl-jmTBv0o69GeifPaISaXGv8LKn3-CyJvUJcjjeHE17KtumJWVxUDRzFqtIMZ1ctCZyIAuWO0n LKilg7_EIDXJrS8k14biqkPO1lXGFwtjo3zLHeFSLw6sWf-CEN9zv6Ff3IAXb-RMYpfh-bVrxIgWsWCxjLW-UKI3la-gs0nWHH2PJr5HLJuI JIOL5HLJuIJIOLWahqTnm_r1LSCSYr6N4C-fh--w2_BW8DzTHalBYe76bNr0d7AqtR4tGazmrvrc79Wa2bjyxmhhN1u9jSaZQqq-3VZEod8q3, WHH2PJ5v1LoXniJQ4a2W8nDVqb6h4E8MUKYOpljTfQ", "status": "ACTIVE", "use": "enc" }, { "_links": { "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/resourceservercredentials/keys/Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo" } }, "created": "2023-04-06T21:32:33.000Z", "e": "AQAB", "id": "apk33a45xfjbDfg6D0g5", "kid": "Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo", "kty": "RSA", "lastUpdated": "2023-04-06T21:32:33.000Z", "n": "l1hZ_g2sgBE3oHvu34T-5XP18FYJWgtul_nRNg-5xra5ySkaXEOJUDRERUG0HrR42uqf9jYrUTwg9fp-SqqNIdHRaN8EwRSDRsKAwK 3 HIJ2NJfgmrrO2ABkeyUq6rzHxAumiKv1iLFpSawSIiTEBJERtUCDcjbbqyHVFuivIFgH8L37 - XDIDb0XG - R8DOoOHLJPTpsgH - rJe M5w96VIRZInsGC5OGWkFdtgk6OkbvVd7_TXcxLCpWeg1vlbmX - 0 TmG5yjSj7ek05txcpxIqYu - 7 FIGT0KKvXge_BOSEUlJpBhLKU28 OtsOnmc3NLIGXB - GeDiUZiBYQdPR - myB4ZoQ", "status": "INACTIVE", "use": "enc" } ] }, "ListOAuthClientCredentialsServer": { "summary": "List containing OAuth 2.0 client credentials SMTP server", "value": { "email-servers": [ { "alias": "OAuthServer1", "authType": "OAUTH2_CLIENT_CREDENTIALS", "clientId": "oauth-client-id", "enabled": true, "host": "smtp.oauth.com", "id": "ces7n3u7sSohfoaou0g2", "port": 587, "scopes": [ "send_email" ], "tokenEndpoint": "https://oauth.example.com/token", "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC", "username": "user@oauth.com" } ] }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "ListOAuthJWTServer": { "summary": "List containing OAuth 2.0 JWT bearer grant SMTP server", "value": { "email-servers": [ { "alias": "OAuthServer2", "audience": "https://smtp.oauth.com", "authType": "OAUTH2_JWT_BEARER_GRANT", "clientId": "oauth-client-id", "enabled": true, "host": "smtp.oauth.com", "id": "ces7n3u7sSohfoaou0g3", "issuer": "https://oauth.example.com", "port": 587, "scopes": [ "org.email.send" ], "signingAlgorithm": "RS256", "subject": "user@oauth.com", "tokenEndpoint": "https://oauth.example.com/token", "username": "user@oauth.com" } ] }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "ListOfSecurityEventsProviderInstances": { "summary": "List of security events providers", "value": [ { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://example.okta.com/api/v1/security-events-providers/sse1qg25RpusjUP6m0g5" } }, "id": "sse1qg25RpusjUP6m0g5", "name": "Security events provider with well-known URL", "settings": { "issuer": "Issuer", "jwks_url": "https://example.okta.com/jwks/path", "well_known_url": "https://example.okta.com/.well-known/ssf-configuration" }, "status": "ACTIVE", "type": "okta" }, { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://example.okta.com/api/v1/security-events-providers/sse1qu4fUtsoD12iF0g5/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://example.okta.com/api/v1/security-events-providers/sse1qu4fUtsoD12iF0g5" } }, "id": "sse1qu4fUtsoD12iF0g5", "name": "Security events provider with an issuer and a JWKS URL", "settings": { "issuer": "Issuer", "jwks_url": "https://example.okta.com/jwks/path" }, "status": "ACTIVE", "type": "okta" } ] }, "ListOktaManagedUserAccounts": { "summary": "List Okta managed user accounts", "value": [ { "created": "2023-04-04T15:56:05.000Z", "description": "Shared admin account for managing AD integrations", "email": "shr-ad-admin-01@example.com", "id": "d1b65a78-21ed-429b-8ea3-eec96f2748d6", "lastUpdated": "2023-05-05T18:15:44.000Z", "name": "AD Integrations Admin", "oktaUserId": "00u11s48P9zGW8yqm0g5", "ownerGroupIds": [ "00g57qp78yZT2XBA40g7" ], "ownerUserIds": [ "00u22t59Q0aHbNEXi1h8" ], "status": "NO_ISSUES", "statusDetail": "UNMANAGED", "username": "shr-ad-admin-01@example.com" }, { "created": "2023-06-15T10:30:00.000Z", "description": "Service account for SCIM provisioning", "email": "scim-service@example.com", "id": "e2c76b89-32fe-530c-9fb4-ffd07f3859e7", "lastUpdated": "2023-06-15T10:30:00.000Z", "name": "SCIM Integration Service Account", "oktaUserId": "00u33u60R1bIcOFYj2i9", "ownerGroupIds": [], "ownerUserIds": [ "00u22t59Q0aHbNEXi1h8" ], "status": "UNSECURED", "statusDetail": "STAGED", "username": "scim-service@example.com" } ] }, "ListRealmAssignmentsResponse": { "value": [ { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/realm-assignments/rul2jy7jLUlnO3ng00g4", "method": "GET", "rel": "self" } }, "actions": { "assignUserToRealm": { "realmId": "00g1b7rvh0xPLKXFf0g5" } }, "conditions": { "expression": { "value": "user.profile.role ==\\\"Manager\\\"" }, "profileSourceId": "0oa4enoRyjwSCy5hx0g4" }, "created": "2022-04-04T15:56:05.000Z", "domains": [ "atko.com", "user.com" ], "id": "rul2jy7jLUlnO3ng00g4", "isDefault": false, "lastUpdated": "2022-05-05T18:15:44.000Z", "name": "Realm Assignment 1", "priority": 0, "status": "ACTIVE" }, { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/realm-assignments/rul2jy7jLUlnO5ng00g4", "method": "GET", "rel": "self" } }, "actions": { "assignUserToRealm": { "realmId": "00g1b7rvh0xPLKXFf2g5" } }, "conditions": { "expression": { "value": "string" }, "profileSourceId": "0oa4enoRyjwSCy6hx0g4," }, "created": "2022-04-04T15:56:05.000Z", "domains": [ "atko.com", "user.com" ], "id": "rul2jy7jLUlnO5ng00g4", "isDefault": true, "lastUpdated": "2022-05-05T18:15:44.000Z", "name": "Catch-all", "priority": 499, "status": "ACTIVE" } ] }, "ListRealmAwareUsersResponse": { "summary": "List all users", "value": [ { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4" } }, "activated": null, "created": "2022-04-04T15:56:05.000Z", "credentials": { "password": {}, "provider": { "name": "OKTA", "type": "OKTA" } }, "id": "00u118oQYT4TBGuay0g4", "lastLogin": "2022-05-04T19:50:52.000Z", "lastUpdated": "2022-05-05T18:15:44.000Z", "passwordChanged": "2022-04-04T16:00:22.000Z", "profile": { "email": "alice.smith@example.com", "firstName": "Alice", "lastName": "Smith", "login": "alice.smith@example.com", "mobilePhone": null, "secondEmail": null }, "realmId": "guo1afiNtSnZYILxO0g4", "status": "ACTIVE", "statusChanged": null, "type": { "id": "oty1162QAr8hJjTaq0g4" } } ] }, "ListRealmsResponse": { "value": [ { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/realms/guox9jQ16k9V8IFEL0g3", "method": "GET", "rel": "self" } }, "created": "2022-04-04T15:56:05.000Z", "id": "guox9jQ16k9V8IFEL0g3", "isDefault": false, "lastUpdated": "2022-05-05T18:15:44.000Z", "profile": { "domains": [ "atko.com", "user.com" ], "name": "Car Co", "realmType": "PARTNER" } } ] }, "ListRefreshTokensClientsResponse": { "summary": "List all refresh tokens for a client", "value": [ { "_embedded": { "scopes": [ { "_links": { "scope": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/{scopeId}", "title": "openid" } }, "description": "Signals that a request is an OpenID request", "displayName": "openid", "id": "{scopeId}", "name": "openid" }, { "_links": { "scope": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/scopes/{scopeId}", "itle": "Keep you signed in to the app" } }, "description": "This keeps you signed in to the app, even when you aren't using it.", "displayName": "Keep you signed in to the app", "id": "{scopeID}", "name": "offline_access" } ] }, "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/{appId}", "title": "My Web App" }, "authorizationServer": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}", "title": "Authorization Server name" }, "client": { "href": "https://{yourOktaDomain}/oauth2/v1/clients/{clientId}", "title": "My Web App" }, "revoke": { "hints": { "allow": [ "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/clients/{clientId}/tokens/{tokenId}" }, "self": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/clients/{clientId}/tokens/{tokenId}" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/{userId}", "title": "Joe User" } }, "client_id": "{clientId}", "created": "2023-09-21T19:59:56.000Z", "expiresAt": "2023-09-28T20:00:38.000Z", "id": "{refreshTokenId}", "issuer": "https://{yourOktaDomain}/oauth2/{authorizationServerId}", "lastUpdated": "2023-09-21T20:00:38.000Z", "scopes": [ "offline_access", "openid" ], "status": "ACTIVE", "userId": "{userId}" } ] }, "ListRiskProviderResponse": { "summary": "List risk provider response example", "value": [ { "_links": { "self": { "hints": { "allow": [ "GET", "PUT" ] }, "href": "https://{yourOktaDomain}/api/v1/risk/providers/00rp12r4skkjkjgsn" } }, "action": "log_only", "clientId": "00ckjsfgjkdkjdkkljjsd", "created": "2021-01-05 22:18:30", "id": "00rp12r4skkjkjgsn", "lastUpdated": "2021-01-05 22:18:30", "name": "Risk-Partner-X" } ] }, "ListServiceAccounts": { "summary": "List service accounts with mixed account types", "value": [ { "accountType": "APP_ACCOUNT", "created": "2023-04-04T15:56:05.000Z", "description": "This is for accessing AWS Prod-5", "details": { "appGlobalName": "AWS Account Federation", "appInstanceName": "AWS Prod-5", "credentials": { "username": "testuser@example.com" }, "oktaApplicationId": "aln1aqcs055ZRoizW0g8" }, "id": "a747a818-a4c4-4446-8a87-704216495a08", "lastUpdated": "2023-05-05T18:15:44.000Z", "name": "AWS Prod-5 account", "ownerGroupIds": [ "00g57qp78yZT2XBA40g7" ], "ownerUserIds": [ "00u11s48P9zGW8yqm0g5" ], "status": "NO_ISSUES", "statusDetail": "ROTATED" }, { "accountType": "OKTA_USER_ACCOUNT", "created": "2023-04-04T15:56:05.000Z", "description": "Shared admin account for managing AD integrations", "details": { "credentials": { "username": "shr-ad-admin-01@example.com" }, "email": "shr-ad-admin-01@example.com", "oktaUserId": "00u11s48P9zGW8yqm0g5" }, "id": "d1b65a78-21ed-429b-8ea3-eec96f2748d6", "lastUpdated": "2023-05-05T18:15:44.000Z", "name": "AD Integrations Admin", "ownerGroupIds": [ "00g57qp78yZT2XBA40g7" ], "ownerUserIds": [ "00u11s48P9zGW8yqm0g5" ], "status": "NO_ISSUES", "statusDetail": "UNMANAGED" } ] }, "ListSessionsResponseForGetSessions": { "value": [ { "created": "2022-04-04T15:56:05.000Z", "id": "aps1qqonvr2SZv6o70h8", "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", "importType": "INCREMENTAL", "lastUpdated": "2022-05-05T16:15:44.000Z", "status": "CREATED" }, { "created": "2022-04-04T16:56:05.000Z", "id": "aps1quck606ngubVq0h8", "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", "importType": "INCREMENTAL", "lastUpdated": "2022-05-05T17:15:44.000Z", "status": "TRIGGERED" }, { "created": "2022-04-04T17:56:05.000Z", "id": "aps1qzy2acb5jDlUc0h8", "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", "importType": "INCREMENTAL", "lastUpdated": "2022-05-05T18:15:44.000Z", "status": "IN_PROGRESS" }, { "created": "2022-04-04T18:56:05.000Z", "id": "aps1qqne8c1JHkMdF0h8", "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", "importType": "INCREMENTAL", "lastUpdated": "2022-05-05T19:15:44.000Z", "status": "EXPIRED" }, { "created": "2022-04-04T19:56:05.000Z", "id": "aps1qqonvr2SZv6o70h8", "identitySourceId": "0oa3l6l6WK6h0R0QW0g4", "importType": "INCREMENTAL", "lastUpdated": "2022-05-05T20:15:44.000Z", "status": "CLOSED" } ] }, "ListThemesResponse": { "value": [ { "backgroundImage": null, "emailTemplateTouchPointVariant": "OKTA_DEFAULT", "endUserDashboardTouchPointVariant": "OKTA_DEFAULT", "errorPageTouchPointVariant": "OKTA_DEFAULT", "favicon": "https://{yourOktaDomain}/favicon.ico", "id": "thdul904tTZ6kWVhP0g3", "loadingPageTouchPointVariant": "OKTA_DEFAULT", "logo": "https://{yourOktaDomain}/assets/img/logos/okta-logo.47066819ac7db5c13f4c431b2687cef6.png", "primaryColorContrastHex": "#000000", "primaryColorHex": "#1662dd", "secondaryColorContrastHex": "#000000", "secondaryColorHex": "#ebebed", "signInPageTouchPointVariant": "OKTA_DEFAULT" } ] }, "ListUISchemaResponse": { "summary": "Lists all UI schemas response", "value": [ { "_links": { "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://example.com/api/v1/meta/uischemas/uis4a7liocgcRgcxZ0g7" } }, "created": "2022-07-25T12:56:31.000Z", "id": "uis4a7liocgcRgcxZ0g7", "lastUpdated": "2022-07-26T11:53:59.000Z", "uiSchema": { "buttonLabel": "Submit", "elements": [ { "label": "First name", "options": { "format": "text" }, "scope": "#/properties/firstName", "type": "Control" }, { "label": "Last name", "options": { "format": "text" }, "scope": "#/properties/lastName", "type": "Control" }, { "label": "Email", "options": { "format": "text" }, "scope": "#/properties/email", "type": "Control" }, { "label": "Country code", "options": { "format": "select" }, "scope": "#/properties/countryCode", "type": "Control" }, { "label": "bool2", "options": { "format": "checkbox" }, "scope": "#/properties/bool2", "type": "Control" }, { "label": "date", "options": { "format": "text" }, "scope": "#/properties/date", "type": "Control" }, { "label": "enum", "options": { "format": "radio" }, "scope": "#/properties/enum", "type": "Control" } ], "label": "Sign in", "type": "Group" } }, { "_links": { "self": { "hints": { "allow": [ "GET", "PUT", "DELETE" ] }, "href": "https://example.com/api/v1/meta/uischemas/uis4abjqkkKXVPGAU0g7" } }, "created": "2022-07-25T12:56:31.000Z", "id": "uis4abjqkkKXVPGAU0g7", "lastUpdated": "2022-07-26T11:53:59.000Z", "uiSchema": { "buttonLabel": "Submit", "elements": [ { "label": "First name", "options": { "format": "text" }, "scope": "#/properties/firstName", "type": "Control" }, { "label": "Last name", "options": { "format": "text" }, "scope": "#/properties/lastName", "type": "Control" }, { "label": "Email", "options": { "format": "text" }, "scope": "#/properties/email", "type": "Control" }, { "label": "Country code", "options": { "format": "select" }, "scope": "#/properties/countryCode", "type": "Control" }, { "label": "bool2", "options": { "format": "checkbox" }, "scope": "#/properties/bool2", "type": "Control" }, { "label": "date", "scope": "#/properties/date", "type": "Control" }, { "label": "enum", "options": { "format": "radio" }, "scope": "#/properties/enum", "type": "Control" } ], "label": "Sign in 2", "type": "Group" } } ] }, "ListUserBlocksAnyDevicesResponse": { "value": [ { "appliesTo": "ANY_DEVICES", "type": "DEVICE_BASED" } ] }, "ListUserBlocksUnknownDevicesResponse": { "value": [ { "appliesTo": "UNKNOWN_DEVICES", "type": "DEVICE_BASED" } ] }, "ListUserClients": { "value": [ { "_links": { "grants": { "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7/clients/0oabskvc6442nkvQO0h7/grants" }, "tokens": { "href": "https://{yourOktaDomain}/api/v1/users/00u5t60iloOHN9pBi0h7/clients/0oabskvc6442nkvQO0h7/tokens" } }, "client_id": "0oabskvc6442nkvQO0h7", "client_name": "My App", "client_uri": null, "logo_uri": null } ] }, "ListUserGroups": { "value": [ { "id": "0gabcd1234", "profile": { "description": "Users can access cloud apps", "name": "Cloud app users" } }, { "id": "0gefgh5678", "profile": { "description": "Users can access internal apps", "name": "Internal app users" } } ] }, "ListUsersFieldsResponse": { "description": "Response for query fields=status,profile:(firstName,city)", "summary": "List all users with API projections", "value": [ { "id": "00u1xke1apZnmHgpB1d7", "profile": { "city": "Chicago", "firstName": "Alice" }, "status": "ACTIVE" }, { "id": "00u269cmneNMFHCH51d7", "profile": { "ListUsersResponse": null, "city": "New York", "firstName": "Bob" }, "status": "ACTIVE" } ] }, "ListUsersFilterResponse": { "description": "Filtered response with filter=status+eq%22LOCKED_OUT%22", "summary": "List all users with a filter", "value": [ { "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u3m5wrdPjJYUFb81d6" } }, "activated": "2020-10-22T15:15:30.000Z", "created": "2020-10-22T15:15:30.000Z", "credentials": { "emails": [ { "status": "VERIFIED", "type": "PRIMARY", "value": "johntest@example.com" } ], "password": {}, "provider": { "name": "IMPORT", "type": "IMPORT" } }, "id": "00u3m5wrdPjJYUFb81d6", "lastLogin": null, "lastUpdated": "2020-10-22T16:09:13.000Z", "passwordChanged": "2020-10-22T15:15:30.000Z", "profile": { "email": "johnrichards@example.com", "firstName": "John", "lastName": "Richards", "login": "johnrichards@example.com", "mobilePhone": null, "secondEmail": null }, "status": "LOCKED_OUT", "statusChanged": "2020-10-22T16:09:13.000Z", "type": { "id": "oty2di92xFgQTiKEJ1d6" } } ] }, "ListUsersQResponse": { "description": "Response for query q=john", "summary": "Find a user (q)", "value": [ { "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u3ojhmm3cCa3a221d7" } }, "activated": "2022-05-13T20:05:41.000Z", "created": "2022-05-13T20:05:39.000Z", "credentials": { "emails": [ { "status": "VERIFIED", "type": "PRIMARY", "value": "tony.johnson@example.com" } ], "password": {}, "provider": { "name": "OKTA", "type": "OKTA" } }, "id": "00u3ojhmm3cCa3a221d7", "lastLogin": null, "lastUpdated": "2022-05-13T20:05:41.000Z", "passwordChanged": "2022-05-13T20:05:41.000Z", "profile": { "email": "tony.johnson@example.com", "firstName": "Tony", "lastName": "Johnson", "login": "tony.johnson@example.com", "mobilePhone": null, "secondEmail": null }, "status": "ACTIVE", "statusChanged": "2022-05-13T20:05:41.000Z", "type": { "id": "oty2di92xFgQTiKEJ1d6" } }, { "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u3m5wrdPjJYUFb81d6" } }, "activated": "2020-10-22T15:15:30.000Z", "created": "2020-10-22T15:15:30.000Z", "credentials": { "emails": [ { "status": "VERIFIED", "type": "PRIMARY", "value": "johnmclean@example.com" } ], "password": {}, "provider": { "name": "IMPORT", "type": "IMPORT" } }, "id": "00u3m5wrdPjJYUFb81d6", "lastLogin": null, "lastUpdated": "2020-10-22T16:09:13.000Z", "passwordChanged": "2020-10-22T15:15:30.000Z", "profile": { "email": "johnmclean@example.com", "firstName": "John", "lastName": "Mclean", "login": "johnmclean@example.com", "mobilePhone": null, "secondEmail": null }, "status": "LOCKED_OUT", "statusChanged": "2020-10-22T16:09:13.000Z", "type": { "id": "oty2di92xFgQTiKEJ1d6" } }, { "_links": { "self": { "href": "https://{yourOktaDomain}/api/v1/users/00u3ojdzgjrAhuYGg1d7" } }, "activated": "2022-05-13T20:06:22.000Z", "created": "2022-05-13T20:06:20.000Z", "credentials": { "emails": [ { "status": "VERIFIED", "type": "PRIMARY", "value": "john.j.phillips@example.com" } ], "password": {}, "provider": { "name": "OKTA", "type": "OKTA" } }, "id": "00u3ojdzgjrAhuYGg1d7", "lastLogin": null, "lastUpdated": "2022-05-13T20:06:22.000Z", "passwordChanged": "2022-05-13T20:06:21.000Z", "profile": { "email": "john.j.phillips@example.com", "firstName": "Jack", "lastName": "Phillips", "login": "john.j.phillips@example.com", "mobilePhone": null, "secondEmail": null }, "status": "ACTIVE", "statusChanged": "2022-05-13T20:06:22.000Z", "type": { "id": "oty2di92xFgQTiKEJ1d6" } } ] }, "ListUsersResponse": { "summary": "List all users", "value": [ { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/users/00u118oQYT4TBGuay0g4" } }, "activated": null, "created": "2022-04-04T15:56:05.000Z", "credentials": { "password": {}, "provider": { "name": "OKTA", "type": "OKTA" } }, "id": "00u118oQYT4TBTemp0g4", "lastLogin": "2022-05-04T19:50:52.000Z", "lastUpdated": "2022-05-05T18:15:44.000Z", "passwordChanged": "2022-04-04T16:00:22.000Z", "profile": { "email": "alice.smith@example.com", "firstName": "Alice", "lastName": "Smith", "login": "alice.smith@example.com", "mobilePhone": null, "secondEmail": null }, "status": "ACTIVE", "statusChanged": null, "type": { "id": "oty1162QAr8hJjTaq0g4" } } ] }, "ListUsersSearchResponse": { "description": "Response for search=profile.department%20eq%20%22Engineering%22", "summary": "List all users with search", "value": [ { "activated": null, "created": "2021-11-17T16:11:16.000Z", "id": "00u1xke1apZnmHgpB1d7", "lastLogin": null, "lastUpdated": "2022-05-24T15:39:09.000Z", "passwordChanged": null, "profile": { "department": "Engineering", "email": "ben.richler@example.com", "firstName": "Ben", "lastName": "Richler", "login": "ben.richler@example.com", "mobilePhone": null, "secondEmail": "" }, "status": "STAGED", "statusChanged": null, "type": { "id": "oty2di92xFgQTiKEJ1d6" } }, { "activated": null, "created": "2021-12-17T15:16:55.000Z", "id": "00u269cmneNMFHCH51d7", "lastLogin": null, "lastUpdated": "2022-05-24T15:38:04.000Z", "passwordChanged": "2021-12-17T15:16:56.000Z", "profile": { "department": "Engineering", "email": "janice.benson@gmail.com", "firstName": "Janice", "lastName": "Benson", "login": "janice.benson@gmail.com", "mobilePhone": null, "secondEmail": null }, "status": "PROVISIONED", "statusChanged": null, "type": { "id": "oty2di92xFgQTiKEJ1d6" } } ] }, "ListYubikeyOptTokensResponse": { "summary": "List YubiKey OTP token response", "value": [ { "_links": { "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/org/factors/yubikey_token/tokens/ykkwcx13nrDq8g4oy0g3" } }, "created": "2020-01-14T21:53:09.000Z", "id": "ykkwcx13nrDq8g4oy0g3", "lastUpdated": "2020-01-14T21:53:09.000Z", "lastVerified": "2020-01-14T21:53:06.000Z", "profile": { "serial": "000003632071" }, "status": "UNASSIGNED" }, { "_links": { "deactivate": { "hints": { "allow": [ "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00uu0x8sxTr9HcHOo0g3/factors/ykfxduQAhl89YyPrV0g3" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/org/factors/yubikey_token/tokens/ykkxdtCA1fKVxyu6R0g3" }, "user": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/users/00uu0x8sxTr9HcHOo0g3" } }, "activated": "2020-06-09T23:47:29.000Z", "created": "2020-06-09T23:42:05.000Z", "id": "ykkxdtCA1fKVxyu6R0g3", "lastUpdated": "2020-06-09T23:47:29.000Z", "lastVerified": "2020-06-09T23:47:29.000Z", "profile": { "serial": "000009508427" }, "status": "ACTIVE" } ] }, "ListsAllUserTypes": { "summary": "Lists all user types", "value": [ { "_links": { "schema": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" }, "self": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" } }, "created": "2021-07-05T20:40:38.000Z", "createdBy": "sprz9fj1ycBcsgopy1d6", "default": false, "description": "A new custom user type", "displayName": "New user type", "id": "otyfnly5cQjJT9PnR0g4", "lastUpdated": "2021-07-05T20:40:38.000Z", "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", "name": "newUserType" }, { "_links": { "schema": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" }, "self": { "href": "https://{yourOktaDomain}/api/v1/meta/schemas/user/oscz9fj2jMiRBC1ZT1d6" } }, "created": "2021-07-05T20:40:38.000Z", "createdBy": "sprz9fj1ycBcsgopy1d6", "default": true, "description": "Okta user profile template with default permission settings", "displayName": "User", "id": "otyz9fj2jMiRBC1ZT1d6", "lastUpdated": "2021-07-05T20:40:38.000Z", "lastUpdatedBy": "sprz9fj1ycBcsgopy1d6", "name": "user" } ] }, "ListsOwnerOneResponse": { "summary": "Lists a response with one owner", "value": [ { "displayName": "Product & Engineering", "id": "00g1gae1k0znUcLuU0h8", "lastUpdated": "2023-03-29 18:18:37.0", "originId": "null", "originType": "OKTA_DIRECTORY", "resolved": true, "type": "GROUP" } ] }, "ListsOwnersMultipleResponse": { "summary": "Lists a response with multiple owners", "value": [ { "displayName": "Mabel Mora", "id": "00u1cmbqjkkmFXeqb0h8", "lastUpdated": "2023-03-29T18:30:58.000Z", "originId": "null", "originType": "OKTA_DIRECTORY", "resolved": true, "type": "USER" }, { "displayName": "Cinda Canning", "id": "00u1cmc52x5B86cnZ0h8", "lastUpdated": "2023-03-29T18:30:55.000Z", "originId": "null", "originType": "OKTA_DIRECTORY", "resolved": true, "type": "USER" } ] }, "LogStreamActivateResponse": { "summary": "Activate log stream response", "value": { "_links": { "deactivate": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate", "method": "POST" }, "self": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4", "method": "GET" } }, "created": "2023-03-24T21:02:43.000Z", "id": "0oa1orqUGCIoCGNxf0g4", "lastUpdated": "2023-03-24T21:22:43.000Z", "name": "Example AWS EventBridge", "settings": { "accountId": "123456789012", "eventSourceName": "your-event-source-name", "region": "us-east-2" }, "status": "ACTIVE", "type": "aws_eventbridge" } }, "LogStreamDeactivateResponse": { "summary": "Deactivate log stream response", "value": { "_links": { "activate": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa7agphh5FT7H521d7/lifecycle/activate", "method": "POST" }, "self": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa7agphh5FT7H521d7", "method": "GET" } }, "created": "2023-03-24T21:15:13.000Z", "id": "0oa7agphh5FT7H521d7", "lastUpdated": "2023-03-24T21:23:00.000Z", "name": "Splunk Cloud Example", "settings": { "edition": "aws", "host": "okexample.splunkcloud.com" }, "status": "INACTIVE", "type": "splunk_cloud_logstreaming" } }, "LogStreamGetAllResponse": { "summary": "Lists all log streams", "value": [ { "_links": { "deactivate": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate", "method": "POST" }, "self": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4", "method": "GET" } }, "created": "2023-03-24T21:02:43.000Z", "id": "0oa1orqUGCIoCGNxf0g4", "lastUpdated": "2023-03-24T21:02:43.000Z", "name": "Example AWS EventBridge", "settings": { "accountId": "123456789012", "eventSourceName": "your-event-source-name", "region": "us-east-2" }, "status": "ACTIVE", "type": "aws_eventbridge" } ] }, "LogStreamPostRequest": { "summary": "Create an AWS EventBridge log stream", "value": { "name": "Example AWS EventBridge", "settings": { "accountId": "123456789012", "eventSourceName": "your-event-source-name", "region": "us-east-2" }, "type": "aws_eventbridge" } }, "LogStreamPostResponse": { "summary": "AWS EventBridge log stream response", "value": { "_links": { "deactivate": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate", "method": "POST" }, "self": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4", "method": "GET" } }, "created": "2023-03-24T21:02:43.000Z", "id": "0oa1orqUGCIoCGNxf0g4", "lastUpdated": "2023-03-24T21:02:43.000Z", "name": "Example AWS EventBridge", "settings": { "accountId": "123456789012", "eventSourceName": "your-event-source-name", "region": "us-east-2" }, "status": "ACTIVE", "type": "aws_eventbridge" } }, "LogStreamPutRequest": { "summary": "Replace AWS EventBridge name", "value": { "name": "Updated AWS EventBridge", "settings": { "accountId": "123456789012", "eventSourceName": "your-event-source-name", "region": "us-east-2" }, "type": "aws_eventbridge" } }, "LogStreamPutResponse": { "summary": "Replace AWS EventBridge name response", "value": { "_links": { "deactivate": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4/lifecycle/deactivate", "method": "POST" }, "self": { "href": "http://{yourOktaDomain}/api/v1/logStreams/0oa1orqUGCIoCGNxf0g4", "method": "GET" } }, "created": "2023-03-24T21:02:43.000Z", "id": "0oa1orqUGCIoCGNxf0g4", "lastUpdated": "2023-03-24T21:12:43.000Z", "name": "Updated AWS EventBridge", "settings": { "accountId": "123456789012", "eventSourceName": "your-event-source-name", "region": "us-east-2" }, "status": "ACTIVE", "type": "aws_eventbridge" } }, "LogStreamSchemaAws": { "value": { "$id": "http://{yourOktaDomain}/api/v1/meta/schemas/logStream/aws_eventbridge", "$schema": "https://json-schema.org/draft/2020-12/schema", "errorMessage": { "properties": { "name": "Name can't exceed 100 characters." } }, "properties": { "name": { "description": "A name for this log stream in Okta", "pattern": "^.{1,100}$", "title": "Name", "type": "string", "writeOnce": false }, "settings": { "description": "Configuration properties specific to AWS EventBridge", "errorMessage": { "properties": { "accountId": "Account number must be 12 digits.", "eventSourceName": "Event source name can use numbers, letters, the symbols \".\", \"-\" or \"_\". It must use fewer than 76 characters." } }, "properties": { "accountId": { "description": "Your Amazon AWS Account ID.", "pattern": "^\\d{12}$", "title": "AWS Account ID", "type": "string", "writeOnce": true }, "eventSourceName": { "description": "An alphanumeric name (no spaces) to identify this event source in AWS EventBridge.", "pattern": "^[\\.\\-_A-Za-z0-9]{1,75}$", "title": "AWS Event Source Name", "type": "string", "writeOnce": true }, "region": { "description": "The destination AWS region for your system log events.", "oneOf": [ { "const": "us-east-2", "title": "US East (Ohio)" }, { "const": "us-east-1", "title": "US East (N. Virginia)" }, { "const": "us-west-1", "title": "US West (N. California)" }, { "const": "us-west-2", "title": "US West (Oregon)" }, { "const": "ca-central-1", "title": "Canada (Central)" }, { "const": "eu-central-1", "title": "Europe (Frankfurt)" }, { "const": "eu-west-1", "title": "Europe (Ireland)" }, { "const": "eu-west-2", "title": "Europe (London)" }, { "const": "eu-west-3", "title": "Europe (Paris)" }, { "const": "eu-south-1", "title": "Europe (Milan)" }, { "const": "eu-north-1", "title": "Europe (Stockholm)" } ], "title": "AWS Region", "type": "string", "writeOnce": true } }, "required": [ "eventSourceName", "accountId", "region" ], "type": "object" } }, "required": [ "name", "settings" ], "title": "AWS EventBridge", "type": "object" } }, "LogStreamSchemaList": { "value": [ { "$id": "http://{yourOktaDomain}/api/v1/meta/schemas/logStream/aws_eventbridge", "$schema": "https://json-schema.org/draft/2020-12/schema", "errorMessage": { "properties": { "name": "Name can't exceed 100 characters." } }, "properties": { "name": { "description": "A name for this log stream in Okta", "pattern": "^.{1,100}$", "title": "Name", "type": "string", "writeOnce": false }, "settings": { "description": "Configuration properties specific to AWS EventBridge", "errorMessage": { "properties": { "accountId": "Account number must be 12 digits.", "eventSourceName": "Event source name can use numbers, letters, the symbols \".\", \"-\" or \"_\". It must use fewer than 76 characters." } }, "properties": { "accountId": { "description": "Your Amazon AWS Account ID.", "pattern": "^\\d{12}$", "title": "AWS Account ID", "type": "string", "writeOnce": true }, "eventSourceName": { "description": "An alphanumeric name (no spaces) to identify this event source in AWS EventBridge.", "pattern": "^[\\.\\-_A-Za-z0-9]{1,75}$", "title": "AWS Event Source Name", "type": "string", "writeOnce": true }, "region": { "description": "The destination AWS region for your system log events.", "oneOf": [ { "const": "us-east-2", "title": "US East (Ohio)" }, { "const": "us-east-1", "title": "US East (N. Virginia)" }, { "const": "us-west-1", "title": "US West (N. California)" }, { "const": "us-west-2", "title": "US West (Oregon)" }, { "const": "ca-central-1", "title": "Canada (Central)" }, { "const": "eu-central-1", "title": "Europe (Frankfurt)" }, { "const": "eu-west-1", "title": "Europe (Ireland)" }, { "const": "eu-west-2", "title": "Europe (London)" }, { "const": "eu-west-3", "title": "Europe (Paris)" }, { "const": "eu-south-1", "title": "Europe (Milan)" }, { "const": "eu-north-1", "title": "Europe (Stockholm)" } ], "title": "AWS Region", "type": "string", "writeOnce": true } }, "required": [ "eventSourceName", "accountId", "region" ], "type": "object" } }, "required": [ "name", "settings" ], "title": "AWS EventBridge", "type": "object" }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "errorMessage": { "properties": { "name": "Name can't exceed 100 characters." } }, "id": "http://{yourOktaDomain}/api/v1/meta/schemas/logStream/splunk_cloud_logstreaming", "properties": { "name": { "description": "A name for this log stream in Okta", "pattern": "^.{1,100}$", "title": "Name", "type": "string", "writeOnce": false }, "settings": { "description": "Configuration properties specific to Splunk Cloud", "errorMessage": { "properties": { "host": "Host should be a domain without http or https. For example: acme.splunkcloud.com" } }, "properties": { "host": { "description": "The domain for your Splunk Cloud instance without http or https. For example: acme.splunkcloud.com", "pattern": "^([a-z0-9]+(-[a-z0-9]+)*){1,100}\\.splunkcloud(gc|fed)?\\.com$", "title": "Host", "type": "string", "writeOnce": false }, "token": { "description": "The token from your Splunk Cloud HTTP Event Collector (HEC).", "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "title": "HEC Token", "type": "string", "writeOnce": false } }, "required": [ "host", "token" ], "type": "object" } }, "required": [ "name", "settings" ], "title": "Splunk Cloud", "type": "object" } ] }, "LogStreamSchemaSplunk": { "value": { "$schema": "https://json-schema.org/draft/2020-12/schema", "errorMessage": { "properties": { "name": "Name can't exceed 100 characters." } }, "id": "http://{yourOktaDomain}/api/v1/meta/schemas/logStream/splunk_cloud_logstreaming", "properties": { "name": { "description": "A name for this log stream in Okta", "pattern": "^.{1,100}$", "title": "Name", "type": "string", "writeOnce": false }, "settings": { "description": "Configuration properties specific to Splunk Cloud", "errorMessage": { "properties": { "host": "Host should be a domain without http or https. For example: acme.splunkcloud.com" } }, "properties": { "host": { "description": "The domain for your Splunk Cloud instance without http or https. For example: acme.splunkcloud.com", "pattern": "^([a-z0-9]+(-[a-z0-9]+)*){1,100}\\.splunkcloud(gc|fed)?\\.com$", "title": "Host", "type": "string", "writeOnce": false }, "token": { "description": "The token from your Splunk Cloud HTTP Event Collector (HEC).", "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "title": "HEC Token", "type": "string", "writeOnce": false } }, "required": [ "host", "token" ], "type": "object" } }, "required": [ "name", "settings" ], "title": "Splunk Cloud", "type": "object" } }, "LogTargetChangeDetails": { "summary": "Example of the `changeDetails` property on the target", "value": { "from": { "vpnLocationOptions": "DISABLED", "vpnSettingsZones": { "exclude": null, "include": null } }, "to": { "message": "You must a use VPN to connect to this application", "vpnLocationOptions": "ZONE", "vpnSettingsZones": { "exclude": null, "include": [ "ALL_ZONES" ] } } } }, "MacOSOSAccountListResponse": { "summary": "List of macOS accounts", "value": [ { "_embedded": { "accountLinkedEnrollments": [ { "_embedded": { "lastAuthenticatedOn": "2026-04-09T17:22:56.000Z" }, "created": "2026-01-19T17:22:30.000Z", "id": "ukp1fxtdiJkUQiX220g5", "lastUpdated": "2026-01-19T17:22:30.000Z", "profile": { "authenticationMethod": "PASSWORD" }, "status": "ACTIVE", "type": "platform_sso" } ], "users": [ { "id": "00u1fxs5JcdX9jsfc0g5", "profile": { "email": "carmel.sonne@okta.com", "firstName": "Carmel", "lastName": "Sonne", "login": "carmel.sonne@okta.com" }, "status": "ACTIVE" } ] }, "_links": { "device": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4/os-accounts/dao3qgkIEKjhNZudR0g4" } }, "created": "2026-01-19T17:22:30.000Z", "deviceId": "guo4a5u7JHHhjXrMK0g4", "id": "dao3qgkIEKjhNZudR0g4", "lastSeenAt": "2026-04-09T17:22:56.000Z", "lastUpdated": "2026-01-19T17:22:30.000Z", "platform": "MACOS", "profile": { "accountUuid": "4ac29c85-d847-4492-96cb-46e337170c33", "fullName": "Carmel Sonne", "type": "MACOS", "username": "carmel.sonne" }, "resourceAlternateId": null, "resourceDisplayName": { "sensitive": false, "value": "Carmel Sonne" }, "resourceId": "dao3qgkIEKjhNZudR0g4", "resourceType": "DOSAccount", "status": "ACTIVE" } ] }, "MacOSOSAccountResponse": { "summary": "macOS account", "value": { "_embedded": { "accountLinkedEnrollments": [ { "_embedded": { "lastAuthenticatedOn": "2026-04-09T17:22:56.000Z" }, "created": "2026-01-19T17:22:30.000Z", "id": "ukp1fxtdiJkUQiX220g5", "lastUpdated": "2026-01-19T17:22:30.000Z", "profile": { "authenticationMethod": "PASSWORD" }, "status": "ACTIVE", "type": "platform_sso" } ], "users": [ { "id": "00u1fxs5JcdX9jsfc0g5", "profile": { "email": "carmel.sonne@okta.com", "firstName": "Carmel", "lastName": "Sonne", "login": "carmel.sonne@okta.com" }, "status": "ACTIVE" } ] }, "_links": { "device": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/devices/guo4a5u7JHHhjXrMK0g4/os-accounts/dao3qgkIEKjhNZudR0g4" } }, "created": "2026-01-19T17:22:30.000Z", "deviceId": "guo4a5u7JHHhjXrMK0g4", "id": "dao3qgkIEKjhNZudR0g4", "lastSeenAt": "2026-04-09T17:22:56.000Z", "lastUpdated": "2026-01-19T17:22:30.000Z", "platform": "MACOS", "profile": { "accountUuid": "4ac29c85-d847-4492-96cb-46e337170c33", "fullName": "Carmel Sonne", "type": "MACOS", "username": "carmel.sonne" }, "resourceAlternateId": null, "resourceDisplayName": { "sensitive": false, "value": "Carmel Sonne" }, "resourceId": "dao3qgkIEKjhNZudR0g4", "resourceType": "DOSAccount", "status": "ACTIVE" } }, "MembershipPayload": { "value": { "memberExternalId": "USEREXT123456784C2IFA" } }, "MicrosoftIdPResponse": { "summary": "Microsoft IdP", "value": { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oajmvdFawBih4gey0g3&\n client_id={clientId}&response_type={responseType}&response_mode={responseMode}&\n scope={scopes}&redirect_uri={redirectUri}&state={state}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2016-03-29T16:47:36.000Z", "id": "0oajmvdFawBih4gey0g3", "lastUpdated": "2016-03-29T16:47:36.000Z", "name": "Microsoft", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": true }, "subject": { "filter": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.userPrincipalName" } }, "trustClaims": false }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" }, "token": { "binding": "HTTP-POST", "url": "https://login.microsoftonline.com/common/oauth2/v2.0/token" } }, "scopes": [ "openid", "email", "profile", "https://graph.microsoft.com/User.Read" ], "type": "OIDC" }, "status": "ACTIVE", "type": "MICROSOFT" } }, "MultipleIdPCsrsResponse": { "summary": "IdP CSRs", "value": [ { "_links": { "publish": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50/lifecycle/publish" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50" } }, "created": "2017-03-28T01:11:10.000Z", "csr": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9/tKvvbFN59T4raoCs/78KRm4fSefHQOv1TKLXo4wTLbsqYWRWc5u0sd5orUMQgPQOyj3i6qh13mALY4BzrT057EG1BUNjGg29QgYlnOk2iX890e5BIDMQQEIKFrvOi2V8cLUkLvE2ydRn0VO1Q1frbUkYeStJYC5Api2JQsYRwa+1ZeDH1ITnIzUaugWhW2WB2lSnwZkenne5KtffxMPYVu+IhNRHoKaRA6Z51YNhMJIx17JM2hs/H4Ka3drk6kzDf7ofk/yBpb9yBWyU7CTSQhdoHidxqFprMDaT66W928t3AeOENHBuwn8c2K9WeGG+bELNyQRJVmawIDAQABoCowKAYJKoZIhvcNAQkOMRswGTAXBgNVHREEEDAOggxkZXYub2t0YS5jb20wDQYJKoZIhvcNAQELBQADggEBAA2hsVJRVM+A83X9MekjTnIbt19UNT8wX7wlE9jUKirWsxceLiZBpVGn9qfKhhVIpvdaIRSeoFYS2Kg/m1G6bCvjmZLcrQ5FcEBjZH2NKfNppGVnfC2ugtUkBtCB+UUzOhKhRKJtGugenKbP33zRWWIqnd2waF6Cy8TIuqQVPbwEDN9bCbAs7ND6CFYNguY7KYjWzQOeAR716eqpEEXuPYAS4nx/ty4ylonR8cv+gpq51rvq80A4k/36aoeM0Y6I4w64vhTfuvWW2UYFUD+/+y2FA2CSP4JfctySrf1s525v6fzTFZ3qZbB5OZQtP2b8xYWktMzywsxGKDoVDB4wkH4=", "id": "h9zkutaSe7fZX0SwN1GqDApofgD1OW8g2B5l2azha50", "kty": "RSA" }, { "_links": { "publish": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/-_-BFwAGoUYN-DDvsSKQFdx7OXaPZqrEPpFDO1hu-rg/lifecycle/publish" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oad5lTSBOMUBOBVVQSC/credentials/csrs/-_-BFwAGoUYN-DDvsSKQFdx7OXaPZqrEPpFDO1hu-rg" } }, "created": "2017-03-28T01:21:10.000Z", "csr": "MIIC4DCCAcgCAQAwcTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEzARBgNVBAoMCk9rdGEsIEluYy4xDDAKBgNVBAsMA0RldjESMBAGA1UEAwwJU1AgSXNzdWVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6m8jHVCr9/tKvvbFN59T4raoCs/78KRm4fSefHQOv1TKLXo4wTLbsqYWRWc5u0sd5orUMQgPQOyj3i6qh13mALY4BzrT057EG1BUNjGg29QgYlnOk2iX890e5BIDMQQEIKFrvOi2V8cLUkLvE2ydRn0VO1Q1frbUkYeStJYC5Api2JQsYRwa+1ZeDH1ITnIzUaugWhW2WB2lSnwZkenne5KtffxMPYVu+IhNRHoKaRA6Z51YNhMJIx17JM2hs/H4Ka3drk6kzDf7ofk/yBpb9yBWyU7CTSQhdoHidxqFprMDaT66W928t3AeOENHBuwn8c2K9WeGG+bELNyQRJVmawIDAQABoCowKAYJKoZIhvcNAQkOMRswGTAXBgNVHREEEDAOggxkZXYub2t0YS5jb20wDQYJKoZIhvcNAQELBQADggEBAA2hsVJRVM+A83X9MekjTnIbt19UNT8wX7wlE9jUKirWsxceLiZBpVGn9qfKhhVIpvdaIRSeoFYS2Kg/m1G6bCvjmZLcrQ5FcEBjZH2NKfNppGVnfC2ugtUkBtCB+UUzOhKhRKJtGugenKbP33zRWWIqnd2waF6Cy8TIuqQVPbwEDN9bCbAs7ND6CFYNguY7KYjWzQOeAR716eqpEEXuPYAS4nx/ty4ylonR8cv+gpq51rvq80A4k/36aoeM0Y6I4w64vhTfuvWW2UYFUD+/+y2FA2CSP4JfctySrf1s525v6fzTFZ3qZbB5OZQtP2b8xYWktMzywsxGKDoVDB4wkH4=", "id": "-_-BFwAGoUYN-DDvsSKQFdx7OXaPZqrEPpFDO1hu-rg", "kty": "RSA" } ] }, "MultipleIdPKeyCredentialsResponse": { "summary": "IdP key credentials", "value": [ { "created": "2016-01-03T18:15:47.000Z", "e": "65537", "kid": "your-key-id", "kty": "RSA", "lastUpdated": "2016-01-03T18:15:47.000Z", "n": "101438407598598116085679865987760095721749307901605456708912786847324207000576780508113360584555007890315805735307890113536927352312915634368993759211767770602174860126854831344273970871509573365292777620005537635317282520456901584213746937262823585533063042033441296629204165064680610660631365266976782082747", "use": "sig", "x5c": [ "MIIDnjCCAoagAwIBAgIGAVG3MN+PMA0GCSqGSIb3DQEBBQUAMIGPMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEDAOBgNVBAMMB2V4YW1wbGUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMTUxMjE4MjIyMjMyWhcNMjUxMjE4MjIyMzMyWjCBjzELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRAwDgYDVQQDDAdleGFtcGxlMRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtcnyvuVCrsFEKCwHDenS3Ocjed8eWDv3zLtD2K/iZfE8BMj2wpTfn6Ry8zCYey3mWlKdxIybnV9amrujGRnE0ab6Q16v9D6RlFQLOG6dwqoRKuZy33Uyg8PGdEudZjGbWuKCqqXEp+UKALJHV+k4wWeVH8g5d1n3KyR2TVajVJpCrPhLFmq1Il4G/IUnPe4MvjXqB6CpKkog1+ThWsItPRJPAM+RweFHXq7KfChXsYE7Mmfuly8sDQlvBmQyxZnFHVuiPfCvGHJjpvHy11YlHdOjfgqHRvZbmo30+y0X/oY/yV4YEJ00LL6eJWU4wi7ViY3HP6/VCdRjHoRdr5L/DwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCzzhOFkvyYLNFj2WDcq1YqD4sBy1iCia9QpRH3rjQvMKDwQDYWbi6EdOX0TQ/IYR7UWGj+2pXd6v0t33lYtoKocp/4lUvT3tfBnWZ5KnObi+J2uY2teUqoYkASN7F+GRPVOuMVoVgm05ss8tuMb2dLc9vsx93sDt+XlMTv/2qi5VPwaDtqduKkzwW9lUfn4xIMkTiVvCpe0X2HneD2Bpuao3/U8Rk0uiPfq6TooWaoW3kjsmErhEAs9bA7xuqo1KKY9CdHcFhkSsMhoeaZylZHtzbnoipUlQKSLMdJQiiYZQ0bYL83/Ta9fulr1EERICMFt3GUmtYaZZKHpWSfdJp9" ], "x5t#S256": "wzPVobIrveR1x-PCbjsFGNV-6zn7Rm9KuOWOG4Rk6jE" }, { "alg": "EC", "created": "2020-04-24T20:51:20.000Z", "crv": "P-521", "expiresAt": "2040-03-01T20:22:29.000Z", "kid": "your-kid", "kty": "EC", "lastUpdated": "2020-04-24T20:51:20.000Z", "use": "sig", "x": "Vv5Rh5de5ig7Qg-A-4HDGGDloMlkxp6PDE3nwzgAQPD3XXrLE7G364LhePRpYupQs62WgCoYb4CDXN0erf3WJXg", "x5c": [ "MIICqDCCAgqgAwIBAgIJAOkmCa/S8dHiMAoGCCqGSM49BAMCMG0xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMRAwDgYDVQQKDAdKYW5reUNvMR8wHQYDVQQDDBZUZXN0IElkZW50aXR5IFByb3ZpZGVyMB4XDTIwMDMwNjIwMjIyOVoXDTQwMDMwMTIwMjIyOVowbTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xEDAOBgNVBAoMB0phbmt5Q28xHzAdBgNVBAMMFlRlc3QgSWRlbnRpdHkgUHJvdmlkZXIwgZswEAYHKoZIzj0CAQYFK4EEACMDgYYABABW/lGHl17mKDtCD4D7gcMYYOWgyWTGno8MTefDOABA8PddessTsbfrguF49Gli6lCzrZaAKhhvgINc3R6t/dYleAE3lY6LAocOoLe9xDkeggXNcSuP5fDc1x5R9GHTXl44vLoJOLSLsMbOXVMXIXoqbPDzTSYUy24aFdv4W4LZxW6ak6NQME4wHQYDVR0OBBYEFChTXNWvs4z1qjRVemPDD/hqlDQ4MB8GA1UdIwQYMBaAFChTXNWvs4z1qjRVemPDD/hqlDQ4MAwGA1UdEwQFMAMBAf8wCgYIKoZIzj0EAwIDgYsAMIGHAkIBuDhHMNLbBIsorbKtjxJzHJ2ItCSD2wAwqYv/6JBtA2ulKN5gRTSqdNCnqFsZ1/nYY7FFVXHEuQ2N3pPq7Ri8h84CQSgCq1UQyd0lFtb7+57JbiGb6LVaRqRm7vwx8zLRA+tVjIM1DlQ2Gbxkj3nlkzmM93j9wchiqGdQidyKnF6EBnfd" ], "x5t#S256": "TUx-AIwypm2pZURHNqafk7ZDxqQP_ypzIyUwDDnPOlw", "y": "ATeVjosChw6gt73EOR6CBc1xK4_l8NzXHlH0YdNeXji8ugk4tIuwxs5dUxcheips8PNNJhTLbhoV2_hbgtnFbpqT" } ] }, "MultipleIdPSigningKeyCredentialsResponse": { "summary": "IdP signing key credentials", "value": [ { "created": "2015-12-10T18:56:23.000Z", "expiresAt": "2017-12-10T18:56:22.000Z", "kid": "akm5hvbbevE341ovl0h7", "kty": "RSA", "use": "sig", "x5c": [ "MIIDqDCCApCgAwIBAgIGAVGNQFX5MA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODU1MjJaFw0xNzEyMTAxODU2MjJaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJJjrcnI6cXBiXNq9YDgfYrQe2O5qEHG4MXP8Ue0sMeefFkFEHYHnHUeZCq6WTAGqR+1LFgOl+Eq9We5V+qNlGIfkFkQ3iHGBrIALKqLCd0Et76HicDiegz7j9DtN+lo0hG/gfcw5783L5g5xeQ7zVmCQMkFwoUA0uA3bsfUSrmfORHJL+EMNQT8XIXD8NkG4g6u7ylHVRTLgXbe+W/p04m3EP6l41xl+MhIpBaPxDsyUvcKCNwkZN3aZIin1O9Y4YJuDHxrM64/VtLLp0sC05iawAmfsLunF7rdJAkWUpPn+xkviyNQ3UpvwAYuDr+jKLUdh2reRnm1PezxMIXzBVMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEARnFIjyitrCGbleFr3KeAwdOyeHiRmgeKupX5ZopgXtcseJoToUIinX5DVw2fVZPahqs0Q7/a0wcVnTRpw6946qZCwKd/PvZ1feVuVEA5Ui3+XvHuSH5xLp7NvYG1snNEvlbN3+NDUMlWj2NEbihowUBt9+UxTpQO3+N08q3aZk3hOZ+tHt+1Te7KEEL/4CM28GZ9MY7fSrS7MAgp1+ZXtn+kRlMrXnQ49qBda37brwDRqmSY9PwNMbev3r+9ZHwxr9W5wXW4Ev4C4xngA7RkVoyDbItSUho0I0M0u/LHuppclnXrw97xyO5Z883eIBvPVjfRcxsJxXJ8jx70ATDskw==" ], "x5t#S256": "5GOpy9CQVtfvBmu2T8BHvpKE4OGtC3BuS046t7p9pps" }, { "created": "2015-12-10T18:55:35.000Z", "expiresAt": "2045-01-23T02:15:23.000Z", "kid": "akm5hvbn1vojA9Fsa0h7", "kty": "RSA", "use": "sig", "x5c": [ "MIIDqDCCApCgAwIBAgIGAVGNQFX5MA0GCSqGSIb3DQEBBQUAMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTAeFw0xNTEyMTAxODU1MjJaFw0xNzEyMTAxODU2MjJaMIGUMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGJhbGFjb21wdGVzdDEcMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJJjrcnI6cXBiXNq9YDgfYrQe2O5qEHG4MXP8Ue0sMeefFkFEHYHnHUeZCq6WTAGqR+1LFgOl+Eq9We5V+qNlGIfkFkQ3iHGBrIALKqLCd0Et76HicDiegz7j9DtN+lo0hG/gfcw5783L5g5xeQ7zVmCQMkFwoUA0uA3bsfUSrmfORHJL+EMNQT8XIXD8NkG4g6u7ylHVRTLgXbe+W/p04m3EP6l41xl+MhIpBaPxDsyUvcKCNwkZN3aZIin1O9Y4YJuDHxrM64/VtLLp0sC05iawAmfsLunF7rdJAkWUpPn+xkviyNQ3UpvwAYuDr+jKLUdh2reRnm1PezxMIXzBVMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEARnFIjyitrCGbleFr3KeAwdOyeHiRmgeKupX5ZopgXtcseJoToUIinX5DVw2fVZPahqs0Q7/a0wcVnTRpw6946qZCwKd/PvZ1feVuVEA5Ui3+XvHuSH5xLp7NvYG1snNEvlbN3+NDUMlWj2NEbihowUBt9+UxTpQO3+N08q3aZk3hOZ+tHt+1Te7KEEL/4CM28GZ9MY7fSrS7MAgp1+ZXtn+kRlMrXnQ49qBda37brwDRqmSY9PwNMbev3r+9ZHwxr9W5wXW4Ev4C4xngA7RkVoyDbItSUho0I0M0u/LHuppclnXrw97xyO5Z883eIBvPVjfRcxsJxXJ8jx70ATDskw==" ], "x5t#S256": "7CCyXWwKzH4P6PoBP91B1S_iIZVzuGffVnUXu-BTYQQ" } ] }, "MultipleIdPsResponse": { "summary": "Multiple IdPs", "value": [ { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62b57p7c8PaGpU0h7&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2016-03-24T23:18:27.000Z", "id": "0oa62b57p7c8PaGpU0h7", "lastUpdated": "2016-03-24T23:18:27.000Z", "name": "Facebook", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": true }, "subject": { "filter": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.userPrincipalName" } }, "trustClaims": false }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://www.facebook.com/dialog/oauth" }, "token": { "binding": "HTTP-POST", "url": "https://graph.facebook.com/v2.5/oauth/access_token" } }, "scopes": [ "public_profile", "email" ], "type": "OAUTH2" }, "status": "ACTIVE", "type": "FACEBOOK" }, { "_links": { "acs": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/sso/saml2/0oa62bc8wppPw0UGr0h7", "type": "application/xml" }, "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/lifecycle/deactivate" }, "metadata": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/metadata.xml", "type": "application/xml" }, "users": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bc8wppPw0UGr0h7/users" } }, "created": "2016-03-24T23:14:54.000Z", "id": "0oa62bc8wppPw0UGr0h7", "lastUpdated": "2016-03-24T23:14:54.000Z", "name": "Example SAML IdP", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": true }, "subject": { "filter": "(\\S+@example\\.com)", "matchType": "USERNAME", "userNameTemplate": { "template": "saml.subjectNameId" } }, "trustClaims": false }, "protocol": { "algorithms": { "request": { "signature": { "algorithm": "SHA-256", "scope": "REQUEST" } }, "response": { "signature": { "algorithm": "SHA-256", "scope": "ANY" } } }, "credentials": { "trust": { "additionalKids": [ "additional-key-id" ], "audience": "http://www.okta.com/123", "issuer": "https://idp.example.com", "kid": "your-key-id" } }, "endpoints": { "acs": { "binding": "HTTP-POST", "type": "INSTANCE" }, "sso": { "binding": "HTTP-POST", "destination": "https://idp.example.com", "url": "https://idp.example.com" } }, "settings": { "nameFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified" }, "type": "SAML2" }, "status": "ACTIVE", "type": "SAML2" }, { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62bfdiumsUndnZ0h7&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2016-03-24T23:21:49.000Z", "id": "0oa62bfdiumsUndnZ0h7", "lastUpdated": "2016-03-24T23:21:49.000Z", "name": "Google", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": true }, "subject": { "filter": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.userPrincipalName" } }, "trustClaims": false }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://accounts.google.com/o/oauth2/auth" }, "token": { "binding": "HTTP-POST", "url": "https://www.googleapis.com/oauth2/v3/token" } }, "scopes": [ "profile", "email", "openid" ], "type": "OIDC" }, "status": "ACTIVE", "type": "GOOGLE" }, { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oa62bfdjnK55Z5x80h7&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2016-03-24T23:23:59.000Z", "id": "0oa62bfdjnK55Z5x80h7", "lastUpdated": "2016-03-24T23:23:59.000Z", "name": "LinkedIn", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": true }, "subject": { "filter": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.userPrincipalName" } }, "trustClaims": false }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://www.linkedin.com/uas/oauth2/authorization" }, "token": { "binding": "HTTP-POST", "url": "https://www.linkedin.com/uas/oauth2/accessToken" } }, "scopes": [ "r_basicprofile", "r_emailaddress" ], "type": "OAUTH2" }, "status": "ACTIVE", "type": "LINKEDIN" }, { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oajmvdFawBih4gey0g3&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2016-03-29T16:47:36.000Z", "id": "0oajmvdFawBih4gey0g3", "lastUpdated": "2016-03-29T16:47:36.000Z", "name": "Microsoft", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": true }, "subject": { "filter": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.userPrincipalName" } }, "trustClaims": false }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" }, "token": { "binding": "HTTP-POST", "url": "https://login.microsoftonline.com/common/oauth2/v2.0/token" } }, "scopes": [ "openid", "email", "profile", "https://graph.microsoft.com/User.Read" ], "type": "OIDC" }, "status": "ACTIVE", "type": "MICROSOFT" }, { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize?idp=0oaulob4BFVa4zQvt0g3&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}&nonce={nonce}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/oauth2/v1/authorize/callback" } }, "created": "2019-02-07T20:07:47.000Z", "id": "0oaulob4BFVa4zQvt0g3", "lastUpdated": "2019-02-07T20:07:47.000Z", "name": "Example OpenID Connect IdP", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": false }, "subject": { "filter": null, "matchAttribute": null, "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.email" } }, "trustClaims": false }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "client_secret": "your-client-secret" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/authorize" }, "jwks": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/keys" }, "token": { "binding": "HTTP-POST", "url": "https://idp.example.com/token" }, "userInfo": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/userinfo" } }, "issuer": { "url": "https://idp.example.com" }, "scopes": [ "openid" ], "type": "OIDC" }, "status": "ACTIVE", "type": "OIDC" }, { "_links": { "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}.okta.com/api/v1/idps/0oa6jxasyhwM2ZHJh0g4/lifecycle/deactivate" }, "keys": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}.okta.com/api/v1/idps/credentials/keys/45dec5ff-8cdc-48c0-85fe-a4869f1753dc" }, "users": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}.okta.com/api/v1/idps/0oa6jxasyhwM2ZHJh0g4/users" } }, "created": "2020-01-07T00:19:27.000Z", "id": "0oa6jxasyhwM2ZHJh0g4", "lastUpdated": "2020-01-07T00:19:27.000Z", "name": "Smart Card IDP Name", "policy": { "mapAMRClaims": false, "maxClockSkew": 0, "provisioning": { "action": "DISABLED", "groups": null, "profileMaster": false }, "subject": { "filter": null, "matchAttribute": null, "matchType": "EMAIL", "userNameTemplate": { "template": "idpuser.subjectAltNameEmail" } }, "trustClaims": false }, "properties": { "additionalAmr": [ "sc", "hwk", "pin", "mfa" ] }, "protocol": { "credentials": { "trust": { "audience": null, "issuer": "CN=Test Smart Card, OU=Test OU, O=Test O, C=US", "kid": "45dec5ff-8cdc-48c0-85fe-a4869f1753dc", "revocation": "CRL", "revocationCacheLifetime": 2880 } }, "endpoints": { "sso": { "url": "https://{yourOktaDomain}.okta.com/login/cert" } }, "type": "MTLS" }, "status": "ACTIVE", "type": "X509" } ] }, "NextAuthorizationServerKey": { "summary": "Next authorization server key", "value": { "_links": { "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/credentials/keys/Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo" } }, "alg": "RS256", "e": "AQAB", "kid": "Y3vBOdYT-l-I0j-gRQ26XjutSX00TeWiSguuDhW3ngo", "kty": "RSA", "n": "l1hZ_g2sgBE3oHvu34T-5XP18FYJWgtul_nRNg-5xra5ySkaXEOJUDRERUG0HrR42uqf9jYrUTwg9fp-SqqNIdHRaN8EwRSDRsKAwK 3 HIJ2NJfgmrrO2ABkeyUq6rzHxAumiKv1iLFpSawSIiTEBJERtUCDcjbbqyHVFuivIFgH8L37 - XDIDb0XG - R8DOoOHLJPTpsgH - rJe M5w96VIRZInsGC5OGWkFdtgk6OkbvVd7_TXcxLCpWeg1vlbmX - 0 TmG5yjSj7ek05txcpxIqYu - 7 FIGT0KKvXge_BOSEUlJpBhLKU28 OtsOnmc3NLIGXB - GeDiUZiBYQdPR - myB4ZoQ", "status": "NEXT", "use": "sig" } }, "NumberMatchingChallengeRequest": { "value": { "useNumberMatchingChallenge": true }, "x-okta-lifecycle": { "SKUs": [], "isGenerallyAvailable": false, "lifecycle": "GA" } }, "NzErrorApiValidationFailed": { "summary": "API Validation Failed", "value": { "errorCauses": [], "errorCode": "E0000003", "errorId": "samplewNxQUR9iohr4QYlD0eg", "errorLink": "E0000003", "errorSummary": "The request body was not well-formed." } }, "NzErrorResourceNotFound": { "summary": "Resource Not Found", "value": { "errorCauses": [], "errorCode": "E0000007", "errorId": "samplejCSVaKFDkCMElmKQ", "errorLink": "E0000007", "errorSummary": "Not found: Resource not found: itd (NetworkZone)" } }, "OAuth2AuthSettings": { "summary": "OAuth2 auth settings example", "value": { "authType": "OAUTH2", "oAuth2Settings": { "authorizeEndpoint": "https://example.com/oauth/authorize", "clientId": "client123", "clientSecret": "secret456", "scopes": [ "scope1", "scope2" ], "tokenEndpoint": "https://example.com/oauth/token" } } }, "OAuth2RefreshTokenResponseEx": { "summary": "OAuth 2.0 refresh token example", "value": { "_embedded": { "scopes": [ { "_links": { "scope": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scppb56cIl4GvGxy70g3", "title": "offline_access" } }, "description": "Requests a refresh token by default and is used to obtain more access tokens without re-prompting the user for authentication", "id": "scppb56cIl4GvGxy70g3", "name": "offline_access" }, { "_links": { "scope": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scp142iq2J8IGRUCS0g4", "title": "Drive car" } }, "description": "Allows the user to drive a car", "displayName": "Drive car", "id": "scp142iq2J8IGRUCS0g4", "name": "car:drive" } ] }, "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7", "title": "Native" }, "authorizationServer": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7", "title": "Example Authorization Server" }, "client": { "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oabskvc6442nkvQO0h7", "title": "Example Client App" }, "revoke": { "hints": { "allow": [ "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3" }, "self": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/00upcgi9dyWEOeCwM0g3", "title": "Saml Jackson" } }, "clientId": "0oabskvc6442nkvQO0h7", "created": "2023-03-09T03:18:06.000Z", "expiresAt": "2023-03-16T03:18:06.000Z", "id": "oar579Mcp7OUsNTlo0g3", "issuer": "https://{yourOktaDomain}/oauth2/ausain6z9zIedDCxB0h7", "lastUpdated": "2023-03-09T03:18:06.000Z", "scopes": [ "offline_access", "car:drive" ], "status": "ACTIVE", "userId": "00u5t60iloOHN9pBi0h7" } }, "OAuth2RefreshTokenResponseListEx": { "summary": "App refresh token list example", "value": [ { "_embedded": { "scopes": [ { "_links": { "scope": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scppb56cIl4GvGxy70g3", "title": "offline_access" } }, "description": "Requests a refresh token by default and is used to obtain more access tokens without re-prompting the user for authentication", "id": "scppb56cIl4GvGxy70g3", "name": "offline_access" }, { "_links": { "scope": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7/scopes/scp142iq2J8IGRUCS0g4", "title": "Drive car" } }, "description": "Allows the user to drive a car", "displayName": "Drive car", "id": "scp142iq2J8IGRUCS0g4", "name": "car:drive" } ] }, "_links": { "app": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7", "title": "Native" }, "authorizationServer": { "href": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7", "title": "Example Authorization Server" }, "client": { "href": "https://{yourOktaDomain}/oauth2/v1/clients/0oabskvc6442nkvQO0h7", "title": "Example Client App" }, "revoke": { "hints": { "allow": [ "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3" }, "self": { "href": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7/tokens/oar579Mcp7OUsNTlo0g3" }, "user": { "href": "https://{yourOktaDomain}/api/v1/users/00upcgi9dyWEOeCwM0g3", "title": "Saml Jackson" } }, "clientId": "0oabskvc6442nkvQO0h7", "created": "2023-03-09T03:18:06.000Z", "expiresAt": "2023-03-16T03:18:06.000Z", "id": "oar579Mcp7OUsNTlo0g3", "issuer": "https://{yourOktaDomain}/oauth2/ausain6z9zIedDCxB0h7", "lastUpdated": "2023-03-09T03:18:06.000Z", "scopes": [ "offline_access", "car:drive" ], "status": "ACTIVE", "userId": "00u5t60iloOHN9pBi0h7" } ] }, "OAuth2ResourceServerJsonWebKey": { "summary": "JSON Web Key example", "value": { "_links": { "delete": { "hints": { "allow": [ "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/authorizationServers/{authorizationServerId}/resourceservercredentials/keys/RQ8DuhdxCczyMvy7GNJb4Ka3lQ99vrSo3oFBUiZjzzc/lifecycle/delete" } }, "alg": "RS256", "created": "2023-04-06T21:32:33.000Z", "e": "AQAB", "id": "apk2f4zrZbs8nUa7p0g4", "kid": "ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B", "kty": "RSA", "lastUpdated": "2023-04-06T21:32:33.000Z", "n": "AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=", "status": "INACTIVE", "use": "enc" } }, "OAuthClientCredentialsPatchRequest": { "summary": "Update OAuth 2.0 client credentials server", "value": { "alias": "OAuthServer1 New Alias", "authType": "OAUTH2_CLIENT_CREDENTIALS", "clientSecret": "New client secret" }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "OAuthClientCredentialsPatchResponse": { "summary": "OAuth 2.0 client credentials server patch response", "value": { "alias": "OAuthServer1 New Alias", "authType": "OAUTH2_CLIENT_CREDENTIALS", "clientId": "oauth-client-id", "enabled": false, "host": "smtp.oauth.com", "id": "ces7n3u7sSohfoaou0g2", "port": 587, "scopes": [ "send_email" ], "tokenEndpoint": "https://oauth.example.com/token", "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC", "username": "user@oauth.com" }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "OAuthClientCredentialsRequest": { "summary": "Create OAuth client credentials server", "value": { "alias": "OAuthServer1", "authType": "OAUTH2_CLIENT_CREDENTIALS", "clientId": "oauth-client-id", "clientSecret": "oauth-client-secret", "enabled": false, "host": "smtp.oauth.com", "port": 587, "scopes": [ "send_email" ], "tokenEndpoint": "https://oauth.example.com/token", "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC", "username": "user@oauth.com" }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "OAuthClientCredentialsResponse": { "summary": "OAuth 2.0 client credentials server response", "value": { "alias": "OAuthServer1", "authType": "OAUTH2_CLIENT_CREDENTIALS", "clientId": "oauth-client-id", "enabled": false, "host": "smtp.oauth.com", "id": "ces7n3u7sSohfoaou0g2", "port": 587, "scopes": [ "send_email" ], "tokenEndpoint": "https://oauth.example.com/token", "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC", "username": "user@oauth.com" }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "OAuthJWTPatchRequest": { "summary": "Update OAuth 2.0 JWT bearer grant server", "value": { "alias": "OAuthServer2 New Alias", "authType": "OAUTH2_JWT_BEARER_GRANT", "keyId": "New keyId", "privateKey": "-----BEGIN PRIVATE KEY-----\n... New Private Key Contents ...\n-----END PRIVATE KEY-----\n" }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "OAuthJWTPatchResponse": { "summary": "OAuth 2.0 JWT bearer grant server patch response", "value": { "alias": "OAuthServer2 New Alias", "audience": "https://smtp.oauth.com", "authType": "OAUTH2_JWT_BEARER_GRANT", "clientId": "oauth-client-id", "enabled": false, "host": "smtp.oauth.com", "id": "ces7n3u7sSohfoaou0g3", "issuer": "https://oauth.example.com", "port": 587, "scopes": [ "org.email.send" ], "signingAlgorithm": "RS256", "subject": "user@oauth.com", "username": "user@oauth.com" }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "OAuthJWTRequest": { "summary": "Create OAuth 2.0 JWT bearer grant server", "value": { "alias": "OAuthServer2", "audience": "https://smtp.oauth.com", "authType": "OAUTH2_JWT_BEARER_GRANT", "clientId": "oauth-client-id", "enabled": false, "host": "smtp.oauth.com", "issuer": "https://oauth.example.com", "keyId": "oauth-key-id", "port": 587, "privateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n", "scopes": [ "org.email.send" ], "signingAlgorithm": "RS256", "subject": "user@oauth.com", "tokenEndpoint": "https://oauth.example.com/token", "username": "user@oauth.com" }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "OAuthJWTResponse": { "summary": "OAuth 2.0 JWT bearer grant server response", "value": { "alias": "OAuthServer2", "audience": "https://smtp.oauth.com", "authType": "OAUTH2_JWT_BEARER_GRANT", "clientId": "oauth-client-id", "enabled": false, "host": "smtp.oauth.com", "id": "ces7n3u7sSohfoaou0g3", "issuer": "https://oauth.example.com", "port": 587, "scopes": [ "org.email.send" ], "signingAlgorithm": "RS256", "subject": "user@oauth.com", "username": "user@oauth.com" }, "x-okta-lifecycle": { "SKUs": [ "Okta Identity Engine" ], "isGenerallyAvailable": false, "lifecycle": "EA" } }, "OktaIntegrationIdpResponse": { "summary": "Okta Integration IdP", "value": { "_links": { "authorize": { "hints": { "allow": [ "GET" ] }, "href": "https://idp.example.com/oauth2/v1/authorize?idp=0oaulob4BFVa4zQvt0g3&client_id={clientId}&response_type={responseType}&response_mode={responseMode}&scope={scopes}&redirect_uri={redirectUri}&state={state}&nonce={nonce}", "templated": true }, "clientRedirectUri": { "hints": { "allow": [ "POST" ] }, "href": "https://idp.example.com/oauth2/v1/authorize/callback" } }, "created": "2025-02-07T20:07:47.000Z", "id": "0oazzok2vl5aeUH0B0g4", "lastUpdated": "2025-02-07T20:07:47.000Z", "name": "Example Okta Integration IdP", "policy": { "accountLink": { "action": "AUTO", "filter": null }, "maxClockSkew": 0, "provisioning": { "action": "AUTO", "conditions": { "deprovisioned": { "action": "NONE" }, "suspended": { "action": "NONE" } }, "groups": { "action": "NONE" }, "profileMaster": false }, "subject": { "filter": "", "matchAttribute": "", "matchType": "USERNAME", "userNameTemplate": { "template": "idpuser.email" } }, "trustClaims": true }, "protocol": { "credentials": { "client": { "client_id": "your-client-id", "pkce_required": "true", "token_endpoint_auth_method": "private_key_jwt" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/oauth2/v1/authorize" }, "jwks": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/oauth2/v1/keys" }, "token": { "binding": "HTTP-POST", "url": "https://idp.example.com/oauth2/v1/token" }, "userInfo": { "binding": "HTTP-REDIRECT", "url": "https://idp.example.com/oauth2/v1/userinfo" } }, "issuer": { "url": "https://idp.example.com" }, "scopes": [ "openid", "email", "profile" ], "type": "OIDC" }, "status": "ACTIVE", "type": "OKTA_INTEGRATION" } }, "OktaManagedUserAccountResponse": { "summary": "Okta managed user account response", "value": { "created": "2023-04-04T15:56:05.000Z", "description": "Shared admin account for managing AD integrations", "email": "shr-ad-admin-01@example.com", "id": "d1b65a78-21ed-429b-8ea3-eec96f2748d6", "lastUpdated": "2023-05-05T18:15:44.000Z", "name": "AD Integrations Admin", "oktaUserId": "00u11s48P9zGW8yqm0g5", "ownerGroupIds": [ "00g57qp78yZT2XBA40g7" ], "ownerUserIds": [ "00u22t59Q0aHbNEXi1h8" ], "status": "UNSECURED", "statusDetail": "STAGED", "username": "shr-ad-admin-01@example.com" } }, "OktaSupportCase": { "summary": "Org Support case", "value": { "impersonation": { "expiration": "2024-01-24T11:13:14.000Z", "status": "ENABLED" }, "selfAssigned": { "status": "NOT_REQUIRED" } } }, "OktaSupportCases": { "summary": "Org Support cases", "value": [ { "caseNumber": "1000001", "impersonation": { "expiration": "2024-01-24T11:13:14.000Z", "status": "ENABLED" }, "selfAssigned": { "status": "REQUESTED" }, "subject": "Reset admin password" }, { "caseNumber": "1000002", "impersonation": { "expiration": null, "status": "REQUESTED" }, "selfAssigned": { "status": "NOT_REQUIRED" }, "subject": "Review IP restriction configuration" } ] }, "OpenidConnectEx": { "summary": "OPENID_CONNECT", "value": { "credentials": { "oauthClient": { "token_endpoint_auth_method": "client_secret_post" } }, "label": "Sample Client profile", "name": "oidc_client", "profile": { "label": "oauth2 client app 1" }, "settings": { "oauthClient": { "application_type": "native", "client_uri": "http://localhost:8080", "grant_types": [ "authorization_code" ], "logo_uri": "http://developer.okta.com/assets/images/logo-new.png", "participate_slo": false, "redirect_uris": [ "https://example.com/oauth2/callback", "myapp://callback" ], "response_types": [ "token", "id_token", "code" ] } }, "signOnMode": "OPENID_CONNECT" } }, "OpenidConnectPutEx": { "summary": "OPENID_CONNECT", "value": { "label": "Sample Client profile updated", "name": "oidc_client", "signOnMode": "OPENID_CONNECT" } }, "OpenidConnectPutResponseEx": { "summary": "OPENID_CONNECT", "value": { "_links": { "appLinks": [ { "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", "name": "customswaapp_link", "type": "text/html" } ], "deactivate": { "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" }, "groups": { "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" }, "logo": [ { "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", "name": "medium", "type": "image/png" } ], "uploadLogo": { "hints": { "allow": [ "POST" ] }, "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" }, "users": { "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" } }, "accessibility": { "errorRedirectUrl": null, "loginRedirectUrl": null, "selfService": false }, "created": "2023-01-21T14:11:24.000Z", "credentials": { "oauthClient": { "autoKeyRotation": true, "client_id": "0oahonkqCRR6TSNlg4", "client_secret": "wj9bOsLK0BRNJqy7KMMnaE7m8qrW51bPO2n1-PYvkOmhHRYgcuOecQkEwq9MPYa5", "pkce_required": true, "token_endpoint_auth_method": "client_secret_post" }, "signing": { "kid": "H34mvc6VrfV5yvy5wA8ikMFws6WInx4nvsAs-7EYbVc" }, "userNameTemplate": { "template": "${source.email}", "type": "BUILT_IN" } }, "features": [], "id": "0oafxqCAJWWGELFTYASJ", "label": "Sample Client profile updated", "lastUpdated": "2023-01-21T14:11:24.000Z", "name": "oidc_client", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:oidc_client:0oafxqCAJWWGELFTYASJ", "settings": { "app": {}, "emOptInStatus": "DISABLED", "implicitAssignment": false, "manualProvisioning": false, "notes": { "admin": null, "enduser": null }, "notifications": { "vpn": { "helpUrl": null, "message": null, "network": { "connection": "DISABLED" } } }, "oauthClient": { "application_type": "native", "client_uri": "http://localhost:8080", "dpop_bound_access_tokens": false, "grant_types": [ "authorization_code" ], "idp_initiated_login": { "default_scope": [], "mode": "DISABLED" }, "issuer_mode": "DYNAMIC", "logo_uri": "http://developer.okta.com/assets/images/logo-new.png", "redirect_uris": [ "https://example.com/oauth2/callback", "myapp://callback" ], "response_types": [ "token", "id_token", "code" ], "wildcard_redirect": "DISABLED" } }, "signOnMode": "OPENID_CONNECT", "status": "ACTIVE", "visibility": { "appLinks": { "oidc_client_link": true }, "autoLaunch": false, "autoSubmitToolbar": false, "hide": { "iOS": true, "web": true } } } }, "OpenidConnectResponseEx": { "summary": "OPENID_CONNECT", "value": { "_links": { "appLinks": [ { "href": "http://{yourOktaDomain}/home/{appName}/0oafxqCAJWWGELFTYASJ/aln5vjkW5oUmDGLMX0g4", "name": "customswaapp_link", "type": "text/html" } ], "deactivate": { "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/lifecycle/deactivate" }, "groups": { "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/groups" }, "logo": [ { "href": "http://{yourOktaDomain}/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png", "name": "medium", "type": "image/png" } ], "uploadLogo": { "hints": { "allow": [ "POST" ] }, "href": "http://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/logo" }, "users": { "href": "https://{yourOktaDomain}/api/v1/apps/0oafxqCAJWWGELFTYASJ/users" } }, "accessibility": { "errorRedirectUrl": null, "loginRedirectUrl": null, "selfService": false }, "created": "2023-01-21T14:11:24.000Z", "credentials": { "oauthClient": { "autoKeyRotation": true, "client_id": "0oahonkqCRR6TSNlg4", "client_secret": "wj9bOsLK0BRNJqy7KMMnaE7m8qrW51bPO2n1-PYvkOmhHRYgcuOecQkEwq9MPYa5", "pkce_required": true, "token_endpoint_auth_method": "client_secret_post" }, "signing": { "kid": "H34mvc6VrfV5yvy5wA8ikMFws6WInx4nvsAs-7EYbVc" }, "userNameTemplate": { "template": "${source.email}", "type": "BUILT_IN" } }, "features": [], "id": "0oafxqCAJWWGELFTYASJ", "label": "Sample Client profile", "lastUpdated": "2023-01-21T14:11:24.000Z", "name": "oidc_client", "orn": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:oidc_client:0oafxqCAJWWGELFTYASJ", "profile": { "label": "oauth2 client app 1" }, "settings": { "app": {}, "emOptInStatus": "DISABLED", "implicitAssignment": false, "manualProvisioning": false, "notes": { "admin": null, "enduser": null }, "notifications": { "vpn": { "helpUrl": null, "message": null, "network": { "connection": "DISABLED" } } }, "oauthClient": { "application_type": "native", "client_uri": "http://localhost:8080", "dpop_bound_access_tokens": false, "grant_types": [ "authorization_code" ], "idp_initiated_login": { "default_scope": [], "mode": "DISABLED" }, "issuer_mode": "DYNAMIC", "logo_uri": "http://developer.okta.com/assets/images/logo-new.png", "redirect_uris": [ "https://example.com/oauth2/callback", "myapp://callback" ], "response_types": [ "token", "id_token", "code" ], "wildcard_redirect": "DISABLED" } }, "signOnMode": "OPENID_CONNECT", "status": "ACTIVE", "visibility": { "appLinks": { "oidc_client_link": true }, "autoLaunch": false, "autoSubmitToolbar": false, "hide": { "iOS": true, "web": true } } } }, "OperationCompletedResponse": { "summary": "Operation Completed Response", "value": { "completed": "2023-10-01T12:10:00Z", "created": "2023-10-01T12:00:00Z", "id": "rdj2ccmltchKESW8u0g5", "started": "2023-10-01T12:05:00Z", "status": "COMPLETED", "type": "read:directories" } }, "OperationFailedResponse": { "summary": "Operation Failed Response", "value": { "completed": "2023-10-01T12:10:00Z", "created": "2023-10-01T12:00:00Z", "id": "rdj2ccmltchKESW8u0g5", "started": "2023-10-01T12:05:00Z", "status": "FAILED", "type": "read:directories" } }, "OperationInProgressResponse": { "summary": "Operation In Progress Response", "value": { "created": "2023-10-01T12:00:00Z", "id": "rdj2ccmltchKESW8u0g5", "started": "2023-10-01T12:05:00Z", "status": "IN_PROGRESS", "type": "read:directories" } }, "OperationResponse": { "value": { "_links": { "self": { "href": "http://your-subdomain.okta.com/api/v1/operations/rre4mje4ez6B2a7B60g7", "method": "GET", "rel": "self" } }, "assignmentOperation": { "configuration": { "actions": { "assignUserToRealm": { "realmId": "00g1b7rvh0xPLKXFf0g5" } }, "conditions": { "expression": { "value": "string" }, "profileSourceId": "0oa4enoRyjwSCy5hx0g4" }, "id": "0pr1b7rxZj2ibQzfP0g5", "name": "Realm Assignment 1" } }, "completed": "2023-10-25T21:02:54.000Z", "created": "2023-10-25T21:02:54.000Z", "id": "rre4mje4ez6B2a7B60g7", "numUserMoved": 50, "realmId": "00g1b7rvh0xPLKXFf0g5", "realmName": "Realm Name", "started": "2023-10-25T21:02:54.000Z", "status": "COMPLETED", "type": "realm:assignment" } }, "OptInStatusResponse": { "summary": "Opt in response", "value": { "_links": { "optInStatus": { "href": "http://your-subdomain.okta.com/api/v1/iam/governance/optIn" } }, "optInStatus": "OPTING_IN" } }, "OptOutStatusResponse": { "summary": "Opt out response", "value": { "_links": { "optInStatus": { "href": "http://your-subdomain.okta.com/api/v1/iam/governance/optIn" } }, "optInStatus": "OPTING_OUT" } }, "OrgCAPTCHASettingsConfigured": { "summary": "org-wide Captcha settings are configured", "value": { "_links": { "self": { "hints": { "allow": [ "GET", "POST", "PUT", "DELETE" ] }, "href": "https://your-subdomain.okta.com/api/v1/captchas/abcd4567" } }, "captchaId": "abcd4567", "enabledPages": [ "SSR", "SIGN_IN" ] } }, "OrgCAPTCHASettingsDisable": { "summary": "Disable org-wide Captcha settings", "value": { "captchaId": "null", "enabledPages": "null" } }, "OrgCAPTCHASettingsDisabled": { "summary": "Disabled org-wide Captcha settings", "value": { "_links": { "self": { "hints": { "allow": [ "GET", "PUT" ] }, "href": "https://your-subdomain.okta.com/api/v1/captchas/" } }, "captchaId": "null", "enabledPages": "[]" } }, "OrgCAPTCHASettingsEmpty": { "summary": "Org-wide Captcha settings aren't configured", "value": { "_links": { "self": { "hints": { "allow": [ "GET", "POST", "PUT", "DELETE" ] }, "href": "https://your-subdomain.okta.com/api/v1/captchas" } }, "captchaId": null, "enabledPages": [] } }, "OrgCAPTCHASettingsUpdate": { "summary": "Update org-wide Captcha settings", "value": { "captchaId": "abcd4567", "enabledPages": [ "SSR", "SIGN_IN" ] } }, "OrgCAPTCHASettingsUpdated": { "summary": "Updated org-wide Captcha settings", "value": { "_links": { "self": { "hints": { "allow": [ "GET", "POST", "PUT", "DELETE" ] }, "href": "https://your-subdomain.okta.com/api/v1/captchas/abcd4567" } }, "captchaId": "abcd4567", "enabledPages": [ "SSR", "SIGN_IN" ] } }, "OrgSettingResponse": { "summary": "Org setting response", "value": { "_links": { "contacts": { "href": "https://vantest.oktapreview.com/api/v1/org/contacts" }, "logo": null, "oktaCommunication": { "href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaCommunication" }, "oktaSupport": { "href": "https://{yourOktaDomain}/api/v1/org/privacy/oktaSupport" }, "preferences": { "href": "https://{yourOktaDomain}/v1/org/preferences" }, "uploadLogo": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/org/logo" } }, "address1": "100 1st St", "address2": "6th floor", "city": "San Fransico", "companyName": "okta", "country": "United States", "created": "2024-01-24T14:15:22Z", "endUserSupportHelpURL": "support.okta.com", "expiresAt": "2024-12-24T14:15:22Z", "id": "00o3qqiw0vSCIwu8I0g7", "lastUpdated": "2024-07-21T14:15:22Z", "phoneNumber": "+18887227871", "postalCode": "94105", "state": "California", "status": "ACTIVE", "subdomain": "okta", "supportPhoneNumber": "+18887227871", "website": "www.okta.com" } }, "PasswordImportPayloadExample": { "summary": "An example password import inline hook request body", "value": { "cloudEventVersion": "0.1", "contentType": "application/json", "data": { "action": { "credential": "UNVERIFIED" }, "context": { "credential": { "password": "Okta", "username": "isaac.brock@example.com" }, "request": { "id": "XiIl6wn7005Rr@fjYqeC7CCDBxw", "ipAddress": "66.124.153.138", "method": "POST", "url": { "value": "/idp/idx/challenge/answer" } } } }, "eventId": "3o9jBzq1SmOGmmsDsqyyeQ", "eventTime": "2020-01-17T21:23:56.000Z", "eventType": "com.okta.user.credential.password.import", "eventTypeVersion": "1.0", "source": "https://${yourOktaDomain}/api/v1/inlineHooks/cbl2ad6phv9fsPLcF0g7" } }, "PasswordImportUnVerifiedResponse": { "summary": "An example password hook response for an unverified user password", "value": { "commands": [ { "type": "com.okta.action.update", "value": { "credential": "UNVERIFIED" } } ] } }, "PasswordImportVerifiedResponse": { "summary": "An example password hook response for a verified user password", "value": { "commands": [ { "type": "com.okta.action.update", "value": { "credential": "VERIFIED" } } ] } }, "PerClientRateLimitSettingsEnforceDefault": { "value": { "defaultMode": "ENFORCE" } }, "PerClientRateLimitSettingsEnforceDefaultWithOverrides": { "value": { "defaultMode": "ENFORCE", "useCaseModeOverrides": { "OAUTH2_AUTHORIZE": "PREVIEW", "OIE_APP_INTENT": "DISABLE" } } }, "PerClientRateLimitSettingsPreviewDefaultWithOverrides": { "value": { "defaultMode": "PREVIEW", "useCaseModeOverrides": { "LOGIN_PAGE": "ENFORCE" } } }, "PermissionResponse": { "value": { "_links": { "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" }, "self": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.manage" } }, "created": "2021-02-06T16:20:57.000Z", "label": "okta.users.manage", "lastUpdated": "2021-02-06T16:20:57.000Z" } }, "PermissionResponseWithConditions": { "value": { "_links": { "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" }, "self": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.read" } }, "conditions": { "include": { "okta:ResourceAttribute/User/Profile": [ "city", "state", "zipCode" ] } }, "created": "2021-02-06T16:20:57.000Z", "label": "okta.users.read", "lastUpdated": "2021-02-06T16:20:57.000Z" } }, "PermissionsResponse": { "value": { "permissions": [ { "_links": { "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" }, "self": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.create" } }, "created": "2021-02-06T16:20:57.000Z", "label": "okta.users.create", "lastUpdated": "2021-02-06T16:20:57.000Z" }, { "_links": { "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" }, "self": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.read" } }, "conditions": { "include": { "okta:ResourceAttribute/User/Profile": [ "city", "state", "zipCode" ] } }, "created": "2021-02-06T16:20:57.000Z", "label": "okta.users.read", "lastUpdated": "2021-02-06T16:20:57.000Z" }, { "_links": { "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" }, "self": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.groups.read" } }, "created": "2021-02-06T16:20:57.000Z", "label": "okta.groups.read", "lastUpdated": "2021-02-06T16:20:57.000Z" }, { "_links": { "role": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3" }, "self": { "href": "https://{yourOktaDomain}/api/v1/iam/roles/cr0Yq6IJxGIr0ouum0g3/permissions/okta.users.userprofile.manage" } }, "created": "2021-02-06T16:20:57.000Z", "label": "okta.users.userprofile.manage", "lastUpdated": "2021-02-06T16:20:57.000Z" } ] } }, "PersonaIDVResponse": { "summary": "Persona as IdP", "value": { "_links": { "activate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdjnK55Z5x80h7/lifecycle/activate" }, "deactivate": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdjnK55Z5x80h7/lifecycle/deactivate" }, "self": { "hints": { "allow": [ "GET", "DELETE" ] }, "href": "https://{yourOktaDomain}/api/v1/idps/0oa62bfdjnK55Z5x80h7" } }, "created": "2023-10-01T12:00:00.000Z", "id": "0oa62bfdjnK55Z5x80h7", "lastUpdated": "2023-10-01T12:00:00.000Z", "name": "Persona IDV", "policy": { "maxClockSkew": 0, "provisioning": { "action": "DISABLED", "groups": null, "profileMaster": false }, "subject": { "filter": null, "matchAttribute": null, "matchType": "USERNAME", "userNameTemplate": { "template": "source.userName" } } }, "properties": { "inquiryTemplateId": "itmpl_HSctx8fNvXoHtrQfz2hxUVH8RBjG" }, "protocol": { "credentials": { "bearer": { "apiKey": "your-api-key" } }, "endpoints": { "authorization": { "binding": "HTTP-REDIRECT", "url": "https://withpersona.com/verify" } }, "type": "ID_PROOFING" }, "status": "ACTIVE", "type": "IDV_PERSONA" } }, "PreviewEmailCustomizationResponse": { "value": { "_links": { "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/customizations/oel2kk1zYJBJbeaGo0g4/preview" }, "template": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" }, "test": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test" } }, "body": "
Hello, John. Click here to activate your account.", "subject": "Welcome to Okta!" } }, "PreviewEmailTemplateDefaultContentResponse": { "value": { "_links": { "defaultContent": { "hints": { "allow": [ "POST" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test/default-content" }, "self": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content/preview" }, "template": { "hints": { "allow": [ "GET" ] }, "href": "https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation" } }, "body": "
Hello, John. Click here to activate your account.",
"subject": "Welcome to Okta!"
}
},
"PrincipalRateLimitEntityReplaceRequestSSWSToken": {
"summary": "Replace a principal rate limit entity request",
"value": {
"defaultConcurrencyPercentage": 75,
"defaultPercentage": 50,
"principalId": "prlh5hd6act3aHDrr1f5",
"principalType": "SSWS_TOKEN"
}
},
"PrincipalRateLimitEntityReplaceResponseSSWSToken": {
"summary": "Replace a principal rate limit entity response example",
"value": {
"createdBy": "00u7xut94qEWYx5ss1d4",
"createdDate": "2022-05-19T20:05:32.720Z",
"defaultConcurrencyPercentage": 75,
"defaultPercentage": 50,
"id": "0oacamvryxiyMqgiY1e5",
"lastUpdate": "2022-05-20T21:13:07.410Z",
"lastUpdatedBy": "00u7xut94qEWYx5ss1d4",
"orgId": "org1234",
"principalId": "prlh5hd6act3aHDrr1f5",
"principalType": "SSWS_TOKEN"
}
},
"PrincipalRateLimitEntityRequestSSWSToken": {
"summary": "Create a principal rate limit entity request example",
"value": {
"defaultConcurrencyPercentage": 75,
"defaultPercentage": 50,
"principalId": "prlh5hd6act3aHDrr1f5",
"principalType": "SSWS_TOKEN"
}
},
"PrincipalRateLimitEntityResponseSSWSToken": {
"summary": "Create a principal rate limit entity response example",
"value": {
"createdBy": "00u7xut94qEWYx5ss1d4",
"createdDate": "2022-05-19T20:05:32.720Z",
"defaultConcurrencyPercentage": 75,
"defaultPercentage": 50,
"id": "0oacamvryxiyMqgiY1e5",
"lastUpdate": "2022-05-20T21:13:07.410Z",
"lastUpdatedBy": "00u7xut94qEWYx5ss1d4",
"orgId": "org1234",
"principalId": "prlh5hd6act3aHDrr1f5",
"principalType": "SSWS_TOKEN"
}
},
"PrincipalRateLimitsOAuthClientListAllExample": {
"summary": "List all OAuth 2.0 client principal rate limits",
"value": [
{
"createdBy": "00uid52637YwIXkJq1d4",
"createdDate": "2023-05-02T20:37:38.000Z",
"defaultConcurrencyPercentage": 40,
"defaultPercentage": 40,
"id": "prl7yh347wuzN5P1C1e7",
"lastUpdate": "2024-11-29T14:56:06.000Z",
"lastUpdatedBy": "00uid52637YwIXkJq1d4",
"orgId": "00o7xut90ucsjAQ7S1e6",
"principalId": "0oa7yh346zIE1y84p1e7",
"principalType": "OAUTH_CLIENT"
},
{
"createdBy": "00uid52637YwIXkJq1d4",
"createdDate": "2023-12-07T21:58:02.000Z",
"defaultConcurrencyPercentage": 50,
"defaultPercentage": 50,
"id": "prlbqdob5bhM6nff61e7",
"lastUpdate": "2023-12-07T21:58:02.000Z",
"lastUpdatedBy": "00uid52637YwIXkJq1d4",
"orgId": "00o7xut90ucsjAQ7S1e6",
"principalId": "0oabqdob4da0JGuMf1e7",
"principalType": "OAUTH_CLIENT"
},
{
"createdBy": "00uid52637YwIXkJq1d4",
"createdDate": "2024-01-12T20:59:18.000Z",
"defaultConcurrencyPercentage": 50,
"defaultPercentage": 50,
"id": "prlcamvrzvkglWHqR1e7",
"lastUpdate": "2024-01-12T20:59:18.000Z",
"lastUpdatedBy": "00uid52637YwIXkJq1d4",
"orgId": "00o7xut90ucsjAQ7S1d7",
"principalId": "0oacamvryxiyMqgiY1e7",
"principalType": "OAUTH_CLIENT"
}
]
},
"PrincipalRateLimitsSSWSListAllExample": {
"summary": "List all SSWS API token principal rate limits",
"value": [
{
"createdBy": "00u7xut94qEWYx5ss1d4",
"createdDate": "2024-09-12T17:28:56.000Z",
"defaultConcurrencyPercentage": 50,
"defaultPercentage": 50,
"id": "prlh5hd7qct3aHDry1f6",
"lastUpdate": "2024-09-12T17:28:56.000Z",
"lastUpdatedBy": "00uid52637YwIXkJq1d4",
"orgId": "00o7xut90ucsjAQ7S1e6",
"principalId": "00T14q3ns31qMEJUU1d7",
"principalType": "SSWS_TOKEN"
},
{
"createdBy": "00uid52637YwIXkJq1d4",
"createdDate": "2024-11-13T17:07:14.000Z",
"defaultConcurrencyPercentage": 50,
"defaultPercentage": 50,
"id": "prlid6w9ilOWlVbpG1f6",
"lastUpdate": "2024-11-13T17:07:14.000Z",
"lastUpdatedBy": "00uid52637YwIXkJq1d4",
"orgId": "00o7xut90ucsjAQ7S1e6",
"principalId": "00T16ewcxyIrMV6Lb1d7",
"principalType": "SSWS_TOKEN"
}
]
},
"PrivilegedResourceClaimAppAccountResponse": {
"value": {
"containerDetails": {
"_links": {
"login": {
"href": "https://appinstance-admin.oktapreview.com/home/google/0oa103099SBEb3Z2b0g4,"
},
"logo": {
"href": "https://appinstance-admin.oktapreview.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png,"
}
},
"appName": "google,",
"containerId": "0oa103099SBEb3Z2b0g4,",
"displayName": "Google App1,",
"globalAppId": "964b82aa-85b4-5645-b790-83312c473480,",
"passwordPushSupported": "true,",
"provisioningEnabled": "true,"
},
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "",
"errorReason": "",
"secretVersionId": "",
"syncState": "NOT_SYNCED",
"syncTime": ""
},
"credentials": {
"userName": "testuser@example.com"
},
"id": "opa100xTfFs4MasRf0g4",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"resourceType": "APP_ACCOUNT",
"status": "ACTIVE"
}
},
"PrivilegedResourceClaimOktaAccountResponse": {
"value": {
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "",
"errorReason": "",
"secretVersionId": "",
"syncState": "NOT_SYNCED",
"syncTime": ""
},
"credentials": {
"userName": "username"
},
"id": "opa100xTfFs4MasRf0g4",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"profile": {
"email": "testuser@example.com"
},
"resourceId": "00u100xTfFs4MasRf0g4,",
"resourceType": "OKTA_USER_ACCOUNT",
"status": "ACTIVE"
}
},
"PrivilegedResourceCreateAppAccountRequest": {
"value": {
"containerDetails": {
"containerId": "0oa103099SBEb3Z2b0g4"
},
"credentials": {
"userName": "testuser@example.com"
},
"resourceType": "APP_ACCOUNT"
}
},
"PrivilegedResourceCreateAppAccountResponse": {
"value": {
"containerDetails": {
"_links": {
"login": {
"href": "https://appinstance-admin.oktapreview.com/home/google/0oa103099SBEb3Z2b0g4,"
},
"logo": {
"href": "https://appinstance-admin.oktapreview.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png,"
}
},
"appName": "google,",
"containerId": "0oa103099SBEb3Z2b0g4,",
"displayName": "Google App1,",
"globalAppId": "964b82aa-85b4-5645-b790-83312c473480,",
"passwordPushSupported": "true,",
"provisioningEnabled": "true,"
},
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "",
"errorReason": "",
"secretVersionId": "",
"syncState": "NOT_SYNCED",
"syncTime": ""
},
"credentials": {
"userName": "testuser@example.com"
},
"id": "opa100xTfFs4MasRf0g4",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"resourceType": "APP_ACCOUNT",
"status": "INACTIVE"
}
},
"PrivilegedResourceCreateOktaAccountRequestConvert": {
"value": {
"resourceId": "00u100xTfFs4MasRf0g4",
"resourceType": "OKTA_USER_ACCOUNT"
}
},
"PrivilegedResourceCreateOktaAccountRequestNew": {
"value": {
"credentials": {
"userName": "username"
},
"profile": {
"email": "testuser@example.com"
},
"resourceType": "OKTA_USER_ACCOUNT"
}
},
"PrivilegedResourceCreateOktaAccountResponse": {
"value": {
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "",
"errorReason": "",
"secretVersionId": "",
"syncState": "NOT_SYNCED",
"syncTime": ""
},
"credentials": {
"userName": "username"
},
"id": "opa100xTfFs4MasRf0g4",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"profile": {
"email": "testuser@example.com"
},
"resourceId": "00u100xTfFs4MasRf0g4,",
"resourceType": "OKTA_USER_ACCOUNT",
"status": "INACTIVE"
}
},
"PrivilegedResourceFilterCreatePayload": {
"summary": "Filters request body",
"value": {
"appGroups": [
{
"externalId": 18070146415,
"name": "domainAdminsGroup1"
},
{
"externalId": 7968626130,
"name": "domainAdminsGroup2"
}
],
"organizationalUnits": [
{
"name": "OU=example1,DN=globo,DN=com"
},
{
"name": "OU=example2,DN=globo,DN=com"
}
]
}
},
"PrivilegedResourceRotatePasswordAppAccountResponse": {
"value": {
"containerDetails": {
"_links": {
"login": {
"href": "https://appinstance-admin.oktapreview.com/home/google/0oa103099SBEb3Z2b0g4,"
},
"logo": {
"href": "https://appinstance-admin.oktapreview.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png,"
}
},
"appName": "google,",
"containerId": "0oa103099SBEb3Z2b0g4,",
"displayName": "Google App1,",
"globalAppId": "964b82aa-85b4-5645-b790-83312c473480,",
"passwordPushSupported": "true,",
"provisioningEnabled": "true,"
},
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "",
"errorReason": "",
"secretVersionId": "9f8400-e29b-41d4-a716-926655440034",
"syncState": "SYNCING",
"syncTime": ""
},
"credentials": {
"userName": "testuser@example.com"
},
"id": "opa100xTfFs4MasRf0g4",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"resourceType": "APP_ACCOUNT",
"status": "ACTIVE"
}
},
"PrivilegedResourceRotatePasswordOktaAccountResponse": {
"value": {
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "",
"errorReason": "",
"secretVersionId": "9f8400-e29b-41d4-a716-926655440034",
"syncState": "SYNCED",
"syncTime": "2024-06-11T11:11:01.000Z"
},
"credentials": {
"userName": "username"
},
"id": "opa100xTfFs4MasRf0g4",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"profile": {
"email": "testuser@example.com"
},
"resourceId": "00u100xTfFs4MasRf0g4,",
"resourceType": "OKTA_USER_ACCOUNT",
"status": "ACTIVE"
}
},
"PrivilegedResourcesAppAccountUpdateRequest": {
"value": {
"username": "username"
}
},
"PrivilegedResourcesFetchResponse": {
"summary": "List privileged resources",
"value": [
{
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "",
"errorReason": "",
"secretVersionId": "9f8400-e29b-41d4-a716-926655440034",
"syncState": "SYNCED",
"syncTime": "2024-06-10T11:30:01.000Z"
},
"credentials": {
"userName": "john.adams@ct12-100k.local.domain"
},
"id": "opa100xTfFs4MasRf0g4",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"profile": {
"displayName": "John Adams",
"dn": "CN=John Adams,OU=Sales,DC=ct12-100k,DC=local",
"email": "john.adams@ct12-100k.local.domain",
"firstName": "John",
"lastName": "Adams",
"objectSid": "sid-1234",
"samAccountName": "john-adams"
},
"resourceType": "APP_ACCOUNT",
"status": "ACTIVE"
},
{
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "",
"errorReason": "",
"secretVersionId": "9f8400-e29b-41d4-a716-926655440034",
"syncState": "SYNCED",
"syncTime": "2024-06-10T11:30:01.000Z"
},
"credentials": {
"userName": "testuser@example.com"
},
"id": "opa100xTfFs4MasRf0g5",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"profile": {
"displayName": "John Doe",
"dn": "CN=John Doe,OU=Sales,DC=ct12-100k,DC=local",
"email": "john.doe@ct12-100k.local.domain",
"firstName": "John",
"lastName": "Doe",
"objectSid": "sid-5678",
"samAccountName": "john-doe"
},
"resourceType": "APP_ACCOUNT",
"status": "ACTIVE"
}
]
},
"PrivilegedResourcesGetAppAccountResponse": {
"value": {
"containerDetails": {
"_links": {
"login": {
"href": "https://appinstance-admin.oktapreview.com/home/google/0oa103099SBEb3Z2b0g4,"
},
"logo": {
"href": "https://appinstance-admin.oktapreview.com/assets/img/logos/default.6770228fb0dab49a1695ef440a5279bb.png,"
}
},
"appName": "google,",
"containerId": "0oa103099SBEb3Z2b0g4,",
"displayName": "Google App1,",
"globalAppId": "964b82aa-85b4-5645-b790-83312c473480,",
"passwordPushSupported": "true,",
"provisioningEnabled": "true,"
},
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "UNKNOWN_ERROR",
"errorReason": "Password update failed",
"secretVersionId": "9f8400-e29b-41d4-a716-926655440034",
"syncState": "SYNC_FAILED",
"syncTime": "2024-06-10T11:30:01.000Z"
},
"credentials": {
"userName": "testuser@example.com"
},
"id": "opa100xTfFs4MasRf0g4",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"resourceType": "APP_ACCOUNT",
"status": "ACTIVE"
}
},
"PrivilegedResourcesGetOktaAccountResponse": {
"value": {
"created": "2024-06-10T11:11:01.000Z",
"credentialSyncInfo": {
"errorCode": "",
"errorReason": "",
"secretVersionId": "9f8400-e29b-41d4-a716-926655440034",
"syncState": "SYNCED",
"syncTime": "2024-06-10T11:30:01.000Z"
},
"credentials": {
"userName": "testuser@example.com"
},
"id": "opa100xTfFs4MasRf0g4",
"lastUpdated": "2024-06-10T11:11:01.000Z",
"profile": {
"email": "testuser@example.com"
},
"resourceId": "00u100xTfFs4MasRf0g4,",
"resourceType": "OKTA_USER_ACCOUNT",
"status": "ACTIVE"
}
},
"PrivilegedResourcesOktaUserAccountUpdateRequest": {
"value": {
"profile": {
"email": "testuser@example.com"
},
"username": "username"
}
},
"ProfileEnrollmentRequest": {
"summary": "An example registration hook profile enrollment (SSR) inline hook request body",
"value": {
"cloudEventVersion": 0.1,
"contentType": "application/json",
"data": {
"action": "ALLOW",
"context": {
"request": {
"id": "123testId456",
"ipAddress": "127.0.0.1",
"method": "POST",
"url": {
"value": "/idp/idx/enroll/new"
}
}
},
"userProfile": {
"email": "rosario.jones@example.com",
"firstName": "Rosario",
"lastName": "Jones",
"login": "rosario.jones@example.com"
}
},
"eventId": "04Dmt8BcT_aEgM",
"eventTime": "2022-04-25T17:35:27.000Z",
"eventType": "com.okta.user.pre-registration",
"eventTypeVersion": 1,
"requestType": "self.service.registration",
"source": "regt4qeBKU29vSoPz0g3"
}
},
"ProfileEnrollmentResponse": {
"summary": "An example registration hook profile enrollment (SSR) inline hook response",
"value": {
"commands": [
{
"type": "com.action.update",
"value": {
"registration": "ALLOW"
}
}
]
}
},
"ProfileEnrollmentResponseDeny": {
"summary": "An example profile enrollment (SSR) inline hook deny response",
"value": {
"commands": [
{
"type": "com.action.update",
"value": {
"registration": "DENY"
}
}
],
"error": {
"errorCauses": [
{
"domain": "end-user",
"errorSummary": "Only example.com emails can register.",
"location": "data.userProfile.email",
"locationType": "body",
"reason": "INVALID_EMAIL_DOMAIN"
}
],
"errorSummary": "Incorrect email address. Please contact your admin."
}
}
},
"ProgressiveProfileRequest": {
"summary": "An example progressive profile inline hook request",
"value": {
"cloudEventVersion": 0.1,
"contentType": "application/json",
"data": {
"action": "ALLOW",
"context": {
"request": {
"id": "123dummyId456",
"ipAddress": "127.0.0.1",
"method": "POST",
"url": {
"value": "/idp/idx/enroll/update"
}
},
"user": {
"_links": {
"factors": {
"href": "/api/v1/users/00u48gwcu01WxvNol0g7/factors"
},
"groups": {
"href": "/api/v1/users/00u48gwcu01WxvNol0g7/groups"
}
},
"id": "00u48gwcu01WxvNo",
"passwordChanged": "2022-01-01T00:00:00.000Z",
"profile": {
"firstName": "Rosario",
"lastName": "Jones\"",
"locale": "en_US",
"login": "rosario.jones@example.com",
"timeZone": "America/Los_Angeles"
}
}
},
"userProfileUpdate": {
"employeeNumber": 1234
}
},
"eventId": "vzYp_zMwQu2htIWRbNJdfw",
"eventTime": "2022-04-25T04:04:41.000Z",
"eventType": "com.okta.user.pre-registration",
"eventTypeVersion": 1,
"requestType": "progressive.profile",
"source": "regt4qeBKU29vS"
}
},
"ProgressiveProfileResponse": {
"summary": "An example progressive profile inline hook response",
"value": {
"commands": [
{
"type": "com.okta.user.progressive.profile.update'",
"value": "request.body.data.userProfileUpdate['employeeNumber']"
}
]
}
},
"ProgressiveProfileResponseDeny": {
"summary": "An example progressive profile inline hook deny response",
"value": {
"commands": [
{
"type": "com.action.update",
"value": {
"registration": "DENY"
}
}
],
"error": {
"errorCauses": [
{
"domain": "end-user",
"errorSummary": "Only employee numbers with 4 digits can register.",
"location": "data.userProfile.employeeNumber",
"locationType": "body",
"reason": "INVALID_EMPLOYEE_NUMBER"
}
],
"errorSummary": "Incorrect employee number. Enter an employee number with 4 digits."
}
}
},
"ProvisioningConnectionOAuthOrg2OrgWithRotationRequestEx": {
"summary": "Provisioning connection with OAuth 2.0 for Okta Org2Org app with key rotation",
"value": {
"profile": {
"authScheme": "OAUTH",
"clientId": "0oa2h6su6bVFyJzIf1d7",
"signing": {
"rotationMode": "AUTO"
}
}
},
"x-okta-lifecycle": {
"SKUs": [],
"isGenerallyAvailable": false,
"lifecycle": "GA"
}
},
"ProvisioningConnectionOAuthOrg2OrgWithRotationResponseEx": {
"summary": "Provisioning connection with OAuth 2.0 for Okta Org2Org (okta_org2org) app",
"value": {
"_links": {
"deactivate": {
"hints": {
"allow": [
"POST"
]
},
"href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default/lifecycle/deactivate"
},
"self": {
"hints": {
"allow": [
"GET",
"POST"
]
},
"href": "https://{yourOktaDomain}/api/v1/apps/${appId}/connections/default"
}
},
"authScheme": "OAUTH2",
"profile": {
"authScheme": "OAUTH2",
"clientId": "0oa2wmzEtqh49C1Sr0g4",
"signing": {
"rotationMode": "AUTO"
}
},
"status": "ENABLED"
},
"x-okta-lifecycle": {
"SKUs": [],
"isGenerallyAvailable": false,
"lifecycle": "GA"
}
},
"ProvisioningConnectionOauthO365RequestEx": {
"summary": "Provisioning connection with OAuth 2.0 for Microsoft Office 365 app",
"value": {
"profile": {
"authScheme": "OAUTH2",
"settings": {
"adminPassword": "office_admin-password",
"adminUsername": "office_admin-username"
}
}
}
},
"ProvisioningConnectionOauthRequestEx": {
"summary": "Provisioning connection with OAuth 2.0",
"value": {
"profile": {
"authScheme": "OAUTH2"
}
}
},
"ProvisioningConnectionOauthResponseEx": {
"summary": "Provisioning connection with OAuth 2.0 for Microsoft Office 365 app",
"value": {
"_links": {
"authorize": {
"guidance": [
"Specifies the URI to invoke in a browser for granting scope consent required to complete the OAuth 2.0 connection."
],
"hints": {
"allow": [
"GET"
]
},
"href": "https://login.microsoftonline.com/myofficetenant.onmicrosoft.com/oauth2/authorize?response_type=code&state=>&client_id=
\nSupported apps:\n * Okta Admin Console (`admin-console`)\n",
"in": "path",
"name": "appName",
"required": true,
"schema": {
"example": "admin-console",
"type": "string"
}
},
"pathGrantId": {
"description": "Grant ID",
"in": "path",
"name": "grantId",
"required": true,
"schema": {
"example": "iJoqkwx50mrgX4T9LcaH",
"type": "string"
}
},
"pathGroupId": {
"description": "The `id` of the group",
"in": "path",
"name": "groupId",
"required": true,
"schema": {
"example": "00g1emaKYZTWRYYRRTSK",
"type": "string"
}
},
"pathGroupPushMappingId": {
"description": "Group push mapping ID",
"in": "path",
"name": "mappingId",
"required": true,
"schema": {
"example": "gPm00000000000000000",
"type": "string"
}
},
"pathGroupRuleId": {
"description": "The `id` of the group rule",
"in": "path",
"name": "groupRuleId",
"required": true,
"schema": {
"example": "0pr3f7zMZZHPgUoWO0g4",
"type": "string"
}
},
"pathHookKeyId": {
"description": "ID of the Hook Key",
"in": "path",
"name": "id",
"required": true,
"schema": {
"example": "XreKU5laGwBkjOTehusG",
"type": "string"
}
},
"pathId": {
"description": "An ID, login, or login shortname (as long as the shortname is unambiguous) of an existing Okta user",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
"pathIdentitySourceExternalId": {
"description": "The external ID of the identity source group",
"example": "GROUPEXT123456784C2IF",
"in": "path",
"name": "externalId",
"required": true,
"schema": {
"type": "string"
}
},
"pathIdentitySourceGroupOrExternalId": {
"description": "The Okta group ID or external ID of the identity source group",
"example": "00gsl4xM9ys8TdnbZ0g4 or GROUPEXT123456784C2IF",
"in": "path",
"name": "groupOrExternalId",
"required": true,
"schema": {
"type": "string"
}
},
"pathIdentitySourceId": {
"description": "The ID of the identity source for which the session is created",
"example": "0oa3l6l6WK6h0R0QW0g4",
"in": "path",
"name": "identitySourceId",
"required": true,
"schema": {
"type": "string"
}
},
"pathIdentitySourceMemberExternalId": {
"description": "The external ID of the identity source user",
"example": "USEREXT123456784C2IFA",
"in": "path",
"name": "memberExternalId",
"required": true,
"schema": {
"type": "string"
}
},
"pathIdentitySourceSessionId": {
"description": "The ID of the identity source session",
"example": "aps1qqonvr2SZv6o70h8",
"in": "path",
"name": "sessionId",
"required": true,
"schema": {
"type": "string"
}
},
"pathIdentitySourceUserId": {
"description": "The ID of the user in the identity source",
"example": "00u7m9p9ZT8k2S2EX1f7",
"in": "path",
"name": "appUserId",
"required": true,
"schema": {
"type": "string"
}
},
"pathIdpCsrId": {
"description": "`id` of the IdP CSR",
"in": "path",
"name": "idpCsrId",
"required": true,
"schema": {
"example": "1uEhyE65oV3H6KM9gYcN",
"type": "string"
}
},
"pathIdpId": {
"description": "`id` of IdP",
"in": "path",
"name": "idpId",
"required": true,
"schema": {
"example": "0oa62bfdjnK55Z5x80h7",
"type": "string"
}
},
"pathInlineHookId": {
"description": "`id` of the inline hook",
"in": "path",
"name": "inlineHookId",
"required": true,
"schema": {
"example": "Y7Rzrd4g4xj6WdKzrBHH",
"type": "string"
}
},
"pathJsonWebKeyId": {
"description": "Unique `id` of the OAuth 2.0 client JSON Web Key",
"example": "pks2f4zrZbs8nUa7p0g4",
"in": "path",
"name": "keyId",
"required": true,
"schema": {
"type": "string"
}
},
"pathKeyId": {
"description": "ID of the Key Credential for the application",
"in": "path",
"name": "keyId",
"required": true,
"schema": {
"example": "sjP9eiETijYz110VkhHN",
"type": "string"
}
},
"pathKid": {
"description": "Unique `id` of the IdP key credential",
"in": "path",
"name": "kid",
"required": true,
"schema": {
"example": "KmMo85SSsU7TZzOShcGb",
"type": "string"
}
},
"pathLifecycle": {
"description": "Whether to `ENABLE` or `DISABLE` the feature",
"in": "path",
"name": "lifecycle",
"required": true,
"schema": {
"$ref": "#/components/schemas/FeatureLifecycle"
}
},
"pathLinkedObjectName": {
"description": "Primary or Associated name",
"in": "path",
"name": "linkedObjectName",
"required": true,
"schema": {
"type": "string"
}
},
"pathLogStreamId": {
"description": "Unique identifier for the log stream",
"in": "path",
"name": "logStreamId",
"required": true,
"schema": {
"example": "0oa1orzg0CHSgPcjZ0g4",
"type": "string"
}
},
"pathLogStreamType": {
"in": "path",
"name": "logStreamType",
"required": true,
"schema": {
"$ref": "#/components/schemas/LogStreamType"
}
},
"pathMappingId": {
"description": "`id` of the Mapping",
"in": "path",
"name": "mappingId",
"required": true,
"schema": {
"example": "cB6u7X8mptebWkffatKA",
"type": "string"
}
},
"pathMemberId": {
"description": "`id` of the member",
"in": "path",
"name": "memberId",
"required": true,
"schema": {
"example": "irb1qe6PGuMc7Oh8N0g4",
"type": "string"
}
},
"pathMethodType": {
"description": "Type of authenticator method",
"in": "path",
"name": "methodType",
"required": true,
"schema": {
"$ref": "#/components/schemas/AuthenticatorMethodType"
}
},
"pathNotificationType": {
"in": "path",
"name": "notificationType",
"required": true,
"schema": {
"$ref": "#/components/schemas/NotificationType"
}
},
"pathOAuthProvisioningAppName": {
"in": "path",
"name": "appName",
"required": true,
"schema": {
"$ref": "#/components/schemas/OAuthProvisioningEnabledApp"
}
},
"pathOperation": {
"in": "path",
"name": "operation",
"required": true,
"schema": {
"type": "string"
}
},
"pathOsAccountId": {
"description": "The unique identifier for the OS account",
"example": "dao3qgkIEKjhNZudR0g4",
"in": "path",
"name": "osAccountId",
"required": true,
"schema": {
"type": "string"
}
},
"pathOwnerId": {
"description": "The `id` of the group owner",
"in": "path",
"name": "ownerId",
"required": true,
"schema": {
"example": "00u1emaK22TWRYd3TtG",
"type": "string"
}
},
"pathPermissionType": {
"description": "An Okta [permission](/openapi/okta-management/guides/permissions)",
"in": "path",
"name": "permissionType",
"required": true,
"schema": {
"example": "okta.users.manage",
"type": "string"
}
},
"pathPolicyId": {
"description": "`id` of the policy",
"in": "path",
"name": "policyId",
"required": true,
"schema": {
"example": "00plrilJ7jZ66Gn0X0g3",
"type": "string"
}
},
"pathPolicyMappingId": {
"description": "`id` of the policy resource Mapping",
"in": "path",
"name": "mappingId",
"required": true,
"schema": {
"example": "maplr2rLjZ6NsGn1P0g3",
"type": "string"
}
},
"pathPoolId": {
"description": "ID of the agent pool for which the settings apply to",
"in": "path",
"name": "poolId",
"required": true,
"schema": {
"type": "string"
}
},
"pathPostureCheckId": {
"description": "ID of the device posture check",
"in": "path",
"name": "postureCheckId",
"required": true,
"schema": {
"type": "string"
}
},
"pathPrimaryRelationshipName": {
"description": "Name of the `primary` relationship being assigned",
"in": "path",
"name": "primaryRelationshipName",
"required": true,
"schema": {
"example": "manager",
"type": "string"
}
},
"pathPrimaryUserId": {
"description": "User ID to be assigned to the `primary` relationship for the `associated` user",
"in": "path",
"name": "primaryUserId",
"required": true,
"schema": {
"type": "string"
}
},
"pathPrincipalRateLimitId": {
"description": "ID of the principal rate limit",
"in": "path",
"name": "principalRateLimitId",
"required": true,
"schema": {
"example": "0oacamvryxiyMqgiY1d7",
"type": "string"
}
},
"pathPublicKeyId": {
"description": "id\" of the Public Key",
"in": "path",
"name": "keyId",
"required": true,
"schema": {
"example": "FcH2P9Eg7wr0o8N2FuV0",
"type": "string"
}
},
"pathPushProviderId": {
"description": "Id of the push provider",
"in": "path",
"name": "pushProviderId",
"required": true,
"schema": {
"type": "string"
}
},
"pathQueryRoleExpand": {
"description": "An optional parameter used to return targets configured for the standard role assignment in the `embedded` property. Supported values: `targets/groups` or `targets/catalog/apps`",
"examples": {
"appTarget": {
"summary": "Return app targets",
"value": "targets/catalog/apps"
},
"groupTarget": {
"summary": "Return group targets",
"value": "targets/groups"
}
},
"in": "query",
"name": "expand",
"required": false,
"schema": {
"type": "string"
}
},
"pathRealmId": {
"description": "ID of the realm",
"in": "path",
"name": "realmId",
"required": true,
"schema": {
"example": "vvrcFogtKCrK9aYq3fgV",
"type": "string"
}
},
"pathRelationshipName": {
"description": "Name of the `primary` or `associated` relationship being queried",
"examples": {
"manager": {
"summary": "Example of a `primary` name",
"value": "manager"
},
"subordinate": {
"summary": "Example of an `associated` name",
"value": "subordinate"
}
},
"in": "path",
"name": "relationshipName",
"required": true,
"schema": {
"type": "string"
}
},
"pathResourceId": {
"description": "`id` of the resource",
"in": "path",
"name": "resourceId",
"required": true,
"schema": {
"example": "ire106sQKoHoXXsAe0g4",
"type": "string"
}
},
"pathResourceSetIdOrLabel": {
"description": "`id` or `label` of the resource set",
"in": "path",
"name": "resourceSetIdOrLabel",
"required": true,
"schema": {
"example": "iamoJDFKaJxGIr0oamd9g",
"type": "string"
}
},
"pathRiskProviderId": {
"description": "`id` of the risk provider object",
"in": "path",
"name": "riskProviderId",
"required": true,
"schema": {
"example": "00rp12r4skkjkjgsn",
"type": "string"
}
},
"pathRoleAssignmentId": {
"description": "The `id` of the role assignment",
"in": "path",
"name": "roleAssignmentId",
"required": true,
"schema": {
"example": "JBCUYUC7IRCVGS27IFCE2SKO",
"type": "string"
}
},
"pathRoleId": {
"description": "`id` of the role",
"in": "path",
"name": "roleId",
"required": true,
"schema": {
"example": "3Vg1Pjp3qzw4qcCK5EdO",
"type": "string"
}
},
"pathRoleIdOrEncodedRoleId": {
"description": "The `id` of the role or Base32 encoded `id` of the role name",
"in": "path",
"name": "roleIdOrEncodedRoleId",
"required": true,
"schema": {
"example": "JBCUYUC7IRCVGS27IFCE2SKO",
"type": "string"
}
},
"pathRoleIdOrLabel": {
"description": "`id` or `label` of the role",
"in": "path",
"name": "roleIdOrLabel",
"required": true,
"schema": {
"example": "cr0Yq6IJxGIr0ouum0g3",
"type": "string"
}
},
"pathRoleRef": {
"description": "A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard roles](/openapi/okta-management/guides/roles/#standard-roles).",
"in": "path",
"name": "roleRef",
"required": true,
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/RoleType"
},
{
"$ref": "#/components/schemas/RoleId"
}
],
"x-okta-ignore-redocly-rules-for-sdk": true
}
},
"pathRuleId": {
"description": "`id` of the policy rule",
"in": "path",
"name": "ruleId",
"required": true,
"schema": {
"example": "ruld3hJ7jZh4fn0st0g3",
"type": "string"
}
},
"pathSchemaId": {
"description": "Schema ID. You can also use `default` to refer to the default user type schema.",
"in": "path",
"name": "schemaId",
"required": true,
"schema": {
"type": "string"
}
},
"pathScopeId": {
"description": "`id` of Scope",
"in": "path",
"name": "scopeId",
"required": true,
"schema": {
"example": "0TMRpCWXRKFjP7HiPFNM",
"type": "string"
}
},
"pathSecretId": {
"description": "`id` of the API Service Integration instance Secret",
"example": "ocs2f4zrZbs8nUa7p0g4",
"in": "path",
"name": "secretId",
"required": true,
"schema": {
"type": "string"
}
},
"pathSection": {
"in": "path",
"name": "section",
"required": true,
"schema": {
"type": "string"
}
},
"pathSecurityEventProviderId": {
"description": "`id` of the security events provider instance",
"in": "path",
"name": "securityEventProviderId",
"required": true,
"schema": {
"example": "sse1qg25RpusjUP6m0g5",
"type": "string"
}
},
"pathSessionId": {
"description": "`id` of the session",
"in": "path",
"name": "sessionId",
"required": true,
"schema": {
"example": "l7FbDVqS8zHSy65uJD85",
"type": "string"
}
},
"pathSubmissionId": {
"description": "OIN integration ID",
"in": "path",
"name": "submissionId",
"required": true,
"schema": {
"example": "acme_submissionapp_1",
"type": "string"
}
},
"pathTargetGroupId": {
"in": "path",
"name": "targetGroupId",
"required": true,
"schema": {
"example": "00g1e9dfjHeLAsdX983d",
"type": "string"
}
},
"pathTemplateId": {
"description": "`id` of the Template",
"in": "path",
"name": "templateId",
"required": true,
"schema": {
"example": "6NQUJ5yR3bpgEiYmq8IC",
"type": "string"
}
},
"pathTemplateName": {
"description": "The name of the email template",
"in": "path",
"name": "templateName",
"required": true,
"schema": {
"type": "string"
}
},
"pathThemeId": {
"description": "The ID of the theme",
"in": "path",
"name": "themeId",
"required": true,
"schema": {
"type": "string"
}
},
"pathTokenId": {
"description": "`id` of Token",
"in": "path",
"name": "tokenId",
"required": true,
"schema": {
"example": "sHHSth53yJAyNSTQKDJZ",
"type": "string"
}
},
"pathTransactionId": {
"description": "ID of an existing factor verification transaction",
"in": "path",
"name": "transactionId",
"required": true,
"schema": {
"example": "gPAQcN3NDjSGOCAeG2Jv",
"type": "string"
}
},
"pathTrustedOriginId": {
"description": "`id` of the trusted origin",
"in": "path",
"name": "trustedOriginId",
"required": true,
"schema": {
"example": "7j2PkU1nyNIDe26ZNufR",
"type": "string"
}
},
"pathTypeId": {
"in": "path",
"name": "typeId",
"required": true,
"schema": {
"description": "The unique key for the user type",
"type": "string"
}
},
"pathUpdateId": {
"description": "ID of the update",
"in": "path",
"name": "updateId",
"required": true,
"schema": {
"type": "string"
}
},
"pathUserId": {
"description": "ID of an existing Okta user",
"in": "path",
"name": "userId",
"required": true,
"schema": {
"example": "00ub0oNGTSWTBKOLGLNR",
"type": "string"
}
},
"pathUserIdOrLogin": {
"description": "If for the `self` link, this is the ID of the user for whom you want to get the primary user ID. If for the `associated` relation, this is the user ID or login value of the user assigned the associated relationship.\n\nThis can be `me` to represent the current session user.",
"examples": {
"manager": {
"summary": "Example ID of `primary`",
"value": "00u5zex6ztMbOZhF50h7"
},
"subordinate": {
"summary": "Example ID of `associated`",
"value": "00u5zex6ztMbOZhF50h7"
}
},
"in": "path",
"name": "userIdOrLogin",
"required": true,
"schema": {
"type": "string"
}
},
"pathWebAuthnMethodType": {
"description": "Type of authenticator method",
"in": "path",
"name": "webAuthnMethodType",
"required": true,
"schema": {
"$ref": "#/components/schemas/AuthenticatorMethodTypeWebAuthn"
}
},
"pathWellKnownUriPath": {
"description": "The path of the well-known URI",
"in": "path",
"name": "path",
"required": true,
"schema": {
"enum": [
"apple-app-site-association",
"assetlinks.json",
"webauthn"
],
"type": "string"
}
},
"pathZoneId": {
"description": "`id` of the Network Zone",
"example": "nzowc1U5Jh5xuAK0o0g3",
"in": "path",
"name": "zoneId",
"required": true,
"schema": {
"type": "string"
}
},
"privQueryAfter": {
"description": "The cursor used for pagination. It represents the last privileged resource ID returned in the previous fetch operation.",
"example": "oprbuthToCeLWOBwh0g4",
"in": "query",
"name": "after",
"schema": {
"type": "string"
}
},
"privQueryLastUpdated": {
"description": "Last updated timestamp query parameter",
"example": "2024-11-03T00:00:00.000Z",
"in": "query",
"name": "lastUpdated",
"schema": {
"type": "string"
}
},
"privQueryLimit": {
"description": "Specifies the batch size of the results to be returned",
"in": "query",
"name": "limit",
"schema": {
"default": 200,
"format": "int32",
"maximum": 1000,
"type": "integer"
}
},
"privQueryStatus": {
"description": "The status of the privileged resource to filter on",
"example": "ACTIVE",
"in": "query",
"name": "status",
"schema": {
"type": "string"
}
},
"privilegedResourceId": {
"description": "ID of an existing privileged resource",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
"queryAfter": {
"description": "The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header).",
"in": "query",
"name": "after",
"schema": {
"type": "string"
}
},
"queryAppAfter": {
"description": "Specifies the pagination cursor for the next page of results. Treat this as an opaque value obtained through the next link relationship. See [Pagination](/#pagination).",
"in": "query",
"name": "after",
"schema": {
"example": 16275000448691,
"type": "string"
}
},
"queryAppGrantsExpand": {
"description": "An optional parameter to return scope details in the `_embedded` property. Valid value: `scope`",
"in": "query",
"name": "expand",
"schema": {
"example": "scope",
"type": "string"
}
},
"queryAppLimit": {
"description": "Specifies the number of objects to return per page.\nIf there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it).\nSee [Pagination](/#pagination).\n",
"in": "query",
"name": "limit",
"schema": {
"default": 50,
"format": "int32",
"maximum": 500,
"minimum": 1,
"type": "integer"
}
},
"queryAppUserExpand": {
"description": "An optional query parameter to return the corresponding [User](/openapi/okta-management/management/tags/user) object in the `_embedded` property.\nValid value: `user`",
"in": "query",
"name": "expand",
"schema": {
"example": "user",
"type": "string"
}
},
"queryAppUserQ": {
"description": "Specifies a filter for the list of application users returned based on their profile attributes.\nThe value of `q` is matched against the beginning of the following profile attributes: `userName`, `firstName`, `lastName`, and `email`.\nThis filter only supports the `startsWith` operation that matches the `q` string against the beginning of the attribute values.\n> **Note:** For OIDC apps, user profiles don't contain the `firstName` or `lastName` attributes. Therefore, the query only matches against the `userName` or `email` attributes.\n",
"in": "query",
"name": "q",
"schema": {
"example": "sam",
"type": "string"
}
},
"queryAppsExpand": {
"description": "An optional parameter used for link expansion to embed more resources in the response.\nOnly supports `expand=user/{userId}` and must be used with the `user.id eq \"{userId}\"` filter query for the same user.\nReturns the assigned [application user](/openapi/okta-management/management/tags/applicationusers) in the `_embedded` property.",
"in": "query",
"name": "expand",
"schema": {
"example": "user/0oa1gjh63g214q0Hq0g4",
"type": "string"
}
},
"queryDiscloseIdentifiers": {
"description": "Indicates whether or not the identifier of an authenticator enrollment is disclosed or anonymized. If it's included in the operation query, then the identifier of the authenticator enrollment (the actual phone number, for example) is included in the response.",
"in": "query",
"name": "discloseIdentifiers",
"schema": {
"items": {
"enum": [
"phone"
],
"type": "string"
},
"type": "array"
}
},
"queryExpand": {
"description": "Valid value: `scope`. If specified, scope details are included in the `_embedded` attribute.",
"in": "query",
"name": "expand",
"schema": {
"type": "string"
}
},
"queryExpandBrand": {
"description": "Specifies additional metadata to be included in the response",
"explode": false,
"in": "query",
"name": "expand",
"required": false,
"schema": {
"items": {
"enum": [
"themes",
"domains",
"emailDomain"
],
"type": "string"
},
"type": "array"
},
"style": "form"
},
"queryExpandEmailDomain": {
"description": "Specifies additional metadata to be included in the response",
"explode": false,
"in": "query",
"name": "expand",
"required": false,
"schema": {
"items": {
"enum": [
"brands"
],
"type": "string"
},
"type": "array"
},
"style": "form"
},
"queryExpandEmailTemplate": {
"description": "Specifies additional metadata to be included in the response",
"explode": false,
"in": "query",
"name": "expand",
"required": false,
"schema": {
"items": {
"enum": [
"settings",
"customizationCount"
],
"type": "string"
},
"type": "array"
},
"style": "form"
},
"queryExpandGroupIdToGroupNameMap": {
"description": "If specified, returns the mapping of group IDs to group names in the `_embedded` object.",
"in": "query",
"name": "expand",
"schema": {
"enum": [
"groupIdToGroupNameMap"
],
"type": "string"
},
"x-okta-added-version": "1.3.0"
},
"queryExpandPageRoot": {
"description": "Specifies additional metadata to be included in the response",
"explode": false,
"in": "query",
"name": "expand",
"required": false,
"schema": {
"items": {
"enum": [
"default",
"customized",
"customizedUrl",
"preview",
"previewUrl"
],
"type": "string"
},
"type": "array"
},
"style": "form"
},
"queryExpandWellKnownUri": {
"description": "Specifies additional metadata to include in the response",
"explode": false,
"in": "query",
"name": "expand",
"required": false,
"schema": {
"items": {
"enum": [
"customized"
],
"type": "string"
},
"type": "array"
},
"style": "form"
},
"queryExpandWellKnownUris": {
"description": "Specifies additional metadata to include in the response",
"explode": false,
"in": "query",
"name": "expand",
"required": false,
"schema": {
"items": {
"enum": [
"all",
"apple-app-site-association",
"assetlinks.json",
"webauthn"
],
"type": "string"
},
"type": "array"
},
"style": "form"
},
"queryFilter": {
"description": "Searches the records for matching value",
"in": "query",
"name": "q",
"schema": {
"type": "string"
}
},
"queryGroupAssignmentLimit": {
"description": "Specifies the number of objects to return per page.\nIf there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it).\nSee [Pagination](/#pagination).",
"examples": {
"hundred": {
"summary": "Sample limit value",
"value": 100
},
"max": {
"summary": "Maximum limit value",
"value": 200
},
"min": {
"summary": "Minimum limit value",
"value": 20
}
},
"in": "query",
"name": "limit",
"schema": {
"default": 20,
"format": "int32",
"maximum": 200,
"minimum": 20,
"type": "integer"
}
},
"queryGroupAssignmentWithGroupExpand": {
"description": "An optional query parameter to return the corresponding assigned [group](openapi/okta-management/management/group) or the group assignment metadata details in the `_embedded` property.",
"examples": {
"group": {
"summary": "Embedded assigned group",
"value": "group"
},
"metadata": {
"summary": "Embedded group assignment metadata",
"value": "metadata"
}
},
"in": "query",
"name": "expand",
"schema": {
"example": "group",
"type": "string"
}
},
"queryGroupAssignmentWithMetadataExpand": {
"description": "An optional query parameter to return the corresponding assigned [group](openapi/okta-management/management/group) or the group assignment metadata details in the `_embedded` property.",
"examples": {
"group": {
"summary": "Embedded assigned group",
"value": "group"
},
"metadata": {
"summary": "Embedded group assignment metadata",
"value": "metadata"
}
},
"in": "query",
"name": "expand",
"schema": {
"example": "metadata",
"type": "string"
}
},
"queryLanguage": {
"description": "The language to use for the email. Defaults to the current user's language if unspecified.",
"in": "query",
"name": "language",
"schema": {
"$ref": "#/components/schemas/Language"
}
},
"queryLimit": {
"description": "A limit on the number of objects to return",
"in": "query",
"name": "limit",
"schema": {
"default": 20,
"maximum": 200,
"minimum": 1,
"type": "integer"
}
},
"queryLimitPerPoolType": {
"description": "Maximum number of agent pools returned",
"in": "query",
"name": "limitPerPoolType",
"required": false,
"schema": {
"default": 5,
"type": "integer"
}
},
"queryOsAccountExpand": {
"description": "Comma-separated list of related resources to include in the `_embedded` attribute. Supported values are `users` and `account_linked_enrollments`.",
"explode": false,
"in": "query",
"name": "expand",
"required": false,
"schema": {
"example": [
"users",
"account_linked_enrollments"
],
"items": {
"enum": [
"users",
"account_linked_enrollments"
],
"type": "string"
},
"type": "array"
},
"style": "form"
},
"queryPoolType": {
"description": "Agent type to search for",
"in": "query",
"name": "poolType",
"required": false,
"schema": {
"$ref": "#/components/schemas/AgentType"
}
},
"queryResultId": {
"description": "The unique identifier returned by the initial POST request (`POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query`)",
"in": "path",
"name": "resultId",
"required": true,
"schema": {
"type": "string"
}
},
"queryScheduled": {
"description": "Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates.",
"in": "query",
"name": "scheduled",
"required": false,
"schema": {
"type": "boolean"
}
},
"querySortOrder": {
"description": "Specifies sort order: `asc` or `desc` (for search queries only). This parameter is ignored if `sortBy` isn't present.",
"in": "query",
"name": "sortOrder",
"schema": {
"default": "asc",
"type": "string"
}
},
"queryUserExpand": {
"description": "An optional parameter to include metadata in the `_embedded` attribute. Valid values: `blocks` or
**Note:** Only the `client_secret_basic` method is supported",
"enum": [
"client_secret_basic"
],
"example": "client_secret_basic",
"type": "string"
},
"scopes": {
"description": "A list of Okta OAuth 2.0 scopes required for the API service app to function",
"items": {
"$ref": "#/components/schemas/Scope"
},
"type": "array"
},
"setupInstructionsUri": {
"description": "The URL for the API service integration configuration document",
"example": "https://example.com/strawberry/help/apiServiceSetup",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"ApiServiceCapability": {
"description": "API Service capability configuration with embedded protocol details",
"properties": {
"capability": {
"description": "API Service capability identifier",
"enum": [
"API_SERVICE"
],
"type": "string"
},
"supportedProtocols": {
"description": "List of supported protocols",
"items": {
"enum": [
"OAUTH2"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"capability",
"supportedProtocols"
],
"type": "object"
},
"ApiToken": {
"description": "An API token for an Okta User. This token is NOT scoped any further and can be used for any API the user has permissions to call.",
"properties": {
"_link": {
"$ref": "#/components/schemas/LinksSelf"
},
"clientName": {
"readOnly": true,
"type": "string"
},
"created": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"expiresAt": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"readOnly": true,
"type": "string"
},
"lastUpdated": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"type": "string"
},
"network": {
"description": "The Network Condition of the API Token",
"properties": {
"connection": {
"description": "The connection type of the Network Condition",
"type": "string"
},
"exclude": {
"description": "List of excluded IP network zones",
"items": {
"type": "string"
},
"type": "array"
},
"include": {
"description": "List of included IP network zones",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"tokenWindow": {
"$ref": "#/components/schemas/TimeDuration"
},
"userId": {
"type": "string"
}
},
"required": [
"name"
],
"title": "API Token",
"type": "object"
},
"ApiTokenUpdate": {
"description": "An API Token Update Object for an Okta user. This token is NOT scoped any further and can be used for any API that the user has permissions to call.",
"properties": {
"clientName": {
"description": "The client name associated with the API Token",
"readOnly": true,
"type": "string"
},
"created": {
"description": "The creation date of the API Token",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name associated with the API Token",
"type": "string"
},
"network": {
"description": "The Network Condition of the API Token",
"properties": {
"connection": {
"description": "The connection type of the Network Condition",
"type": "string"
},
"exclude": {
"description": "List of excluded IP network zones",
"items": {
"type": "string"
},
"type": "array"
},
"include": {
"description": "List of included IP network zones",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"userId": {
"description": "The userId of the user who created the API Token",
"type": "string"
}
},
"title": "API Token Update",
"type": "object"
},
"AppAccountContainerDetails": {
"description": "Container details for resource type APP_ACCOUNT",
"properties": {
"_links": {
"$ref": "#/components/schemas/AppAccountContainerLink"
},
"appName": {
"description": "The application name",
"example": "google",
"readOnly": true,
"type": "string"
},
"containerId": {
"description": "The app ID associated with the privileged resource",
"example": "0oa103099SBEb3Z2b0g4",
"type": "string"
},
"displayName": {
"description": "Human-readable name of the container that owns the privileged resource",
"example": "Google App1",
"readOnly": true,
"type": "string"
},
"globalAppId": {
"description": "The application global ID",
"example": "964b82aa-85b4-5645-b790-83312c473480",
"readOnly": true,
"type": "string"
},
"passwordPushSupported": {
"description": "Indicates if the application supports password push",
"example": true,
"readOnly": true,
"type": "boolean"
},
"provisioningEnabled": {
"description": "Indicates if provisioning is enabled for this application",
"example": true,
"readOnly": true,
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/AppInstanceContainerStatus"
}
},
"required": [
"containerId"
],
"type": "object"
},
"AppAccountContainerLink": {
"properties": {
"login": {
"$ref": "#/components/schemas/HrefObjectAppLink"
},
"logo": {
"$ref": "#/components/schemas/HrefObjectLogoLink"
}
},
"readOnly": true,
"type": "object"
},
"AppAndInstanceConditionEvaluatorAppOrInstance": {
"properties": {
"id": {
"description": "ID of the app",
"readOnly": false,
"type": "string"
},
"name": {
"description": "Name of the app type",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/AppAndInstanceType"
}
},
"type": "object"
},
"AppAndInstancePolicyRuleCondition": {
"description": "Specifies apps to include or exclude. If `include` is empty, then the condition is met for all apps.",
"properties": {
"exclude": {
"description": "The list of apps or app instances to exclude",
"items": {
"$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance"
},
"type": "array"
},
"include": {
"description": "The list of apps or app instances to match on",
"items": {
"$ref": "#/components/schemas/AppAndInstanceConditionEvaluatorAppOrInstance"
},
"type": "array"
}
},
"type": "object"
},
"AppAndInstanceType": {
"description": "Type of app",
"enum": [
"APP",
"APP_TYPE"
],
"type": "string"
},
"AppConfig": {
"description": "Additional app configuration for group push mappings. Currently only required for Active Directory.",
"discriminator": {
"mapping": {
"ACTIVE_DIRECTORY": "#/components/schemas/AppConfigActiveDirectory"
},
"propertyName": "type"
},
"properties": {
"type": {
"$ref": "#/components/schemas/AppConfigType",
"type": "string"
}
},
"type": "object"
},
"AppConfigActiveDirectory": {
"allOf": [
{
"$ref": "#/components/schemas/AppConfig"
}
],
"properties": {
"distinguishedName": {
"description": "The distinguished name of the group in Active Directory",
"type": "string"
},
"groupScope": {
"$ref": "#/components/schemas/ActiveDirectoryGroupScope"
},
"groupType": {
"$ref": "#/components/schemas/ActiveDirectoryGroupType"
},
"samAccountName": {
"description": "The SAM account name of the group in Active Directory",
"type": "string"
}
},
"required": [
"distinguishedName",
"groupScope",
"groupType",
"samAccountName"
],
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"AppConfigType": {
"description": "The type of the app configuration",
"enum": [
"ACTIVE_DIRECTORY"
],
"type": "string"
},
"AppConnectionUserProvisionJWKList": {
"properties": {
"keys": {
"items": {
"$ref": "#/components/schemas/JsonWebKey"
},
"type": "array"
}
},
"required": [
"keys"
]
},
"AppConnectionUserProvisionJWKResponse": {
"properties": {
"jwks": {
"$ref": "#/components/schemas/AppConnectionUserProvisionJWKList"
}
},
"required": [
"jwks"
]
},
"AppCsrPkcs10": {
"description": "Base64URL-encoded CSR in DER format",
"format": "base64",
"type": "string"
},
"AppCustomHrefObject": {
"properties": {
"hints": {
"description": "Describes allowed HTTP verbs for the `href`",
"properties": {
"allow": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"href": {
"description": "Link URI",
"type": "string"
},
"title": {
"description": "Link name",
"type": "string"
},
"type": {
"description": "The media type of the link. If omitted, it is implicitly `application/json`.",
"type": "string"
}
},
"readOnly": true,
"required": [
"href"
],
"type": "object"
},
"AppGroup": {
"properties": {
"externalId": {
"description": "The external ID of the app group whose members might be privileged app users",
"example": 18070146415,
"maxLength": 255,
"type": "string"
},
"name": {
"description": "The name of the app group whose members might be privileged app users",
"example": "domainAdminsGroup",
"maxLength": 255,
"type": "string"
}
},
"required": [
"name",
"externalId"
],
"type": "object"
},
"AppInstanceContainerStatus": {
"description": "Current status of the application instance",
"enum": [
"ACTIVE",
"DELETED",
"INACTIVE"
],
"readOnly": true,
"type": "string"
},
"AppInstancePolicyRuleCondition": {
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array"
},
"include": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AppInstanceProperty": {
"properties": {
"label": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"label"
],
"type": "object"
},
"AppProperties": {
"additionalProperties": {
"properties": {
"name": {
"description": "Name of the property",
"example": "baseUrl",
"type": "string"
},
"value": {
"description": "Value of the property",
"example": "https://example.com",
"type": "string"
}
},
"type": "object"
},
"description": "App instance properties",
"type": "object",
"x-okta-lifecycle": {
"isGenerallyAvailable": true,
"lifecycle": "GA"
}
},
"AppResourceHrefObject": {
"properties": {
"href": {
"description": "Link URI",
"example": "https://{yourOktaDomain}/api/v1/apps/0oabskvc6442nkvQO0h7",
"type": "string"
},
"title": {
"description": "Link name",
"example": "My App",
"type": "string"
}
},
"type": "object"
},
"AppServiceAccount": {
"properties": {
"containerGlobalName": {
"description": "The key name of the app in the Okta Integration Network (OIN)",
"example": "salesforce",
"readOnly": true,
"type": "string"
},
"containerInstanceName": {
"description": "The app instance label",
"example": "salesforce Prod 5",
"readOnly": true,
"type": "string"
},
"containerOrn": {
"description": "The [ORN](/openapi/okta-management/guides/roles/#okta-resource-name-orn) of the relevant resource.\n\nUse the specific app ORN format (`orn:{partition}:idp:{yourOrgId}:apps:{appType}:{appId}`) to identify an Okta app instance in your org.",
"example": "orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:salesforce:0oa1gjh63g214q0Hq0g4",
"type": "string"
},
"created": {
"description": "Timestamp when the app service account was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "The description of the app service account",
"example": "This is for accessing salesforce Prod-5",
"format": "regex",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"id": {
"description": "The UUID of the app service account",
"example": "a747a818-a4c4-4446-8a87-704216495a08",
"format": "regex",
"pattern": "(?i)^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"readOnly": true,
"type": "string"
},
"lastUpdated": {
"description": "Timestamp when the app service account was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The user-defined name for the app service account",
"example": "salesforce Prod-5 account",
"format": "regex",
"maxLength": 50,
"minLength": 1,
"pattern": "^[\\w\\-_. ]+$",
"type": "string"
},
"ownerGroupIds": {
"description": "A list of IDs of the Okta groups who own the app service account",
"example": [
"00g57qp78yZT2XBA40g7"
],
"items": {
"type": "string"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"ownerUserIds": {
"description": "A list of IDs of the Okta users who own the app service account",
"example": [
"00u11s48P9zGW8yqm0g5"
],
"items": {
"type": "string"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"password": {
"description": "The app service account password",
"format": "password",
"maxLength": 255,
"minLength": 1,
"type": "string",
"writeOnly": true
},
"status": {
"$ref": "#/components/schemas/ServiceAccountStatus"
},
"statusDetail": {
"$ref": "#/components/schemas/ServiceAccountStatusDetail"
},
"username": {
"description": "The username that serves as the direct link to your managed app account. Ensure that this value precisely matches the identifier of the target app account.",
"example": "testuser-salesforce-5@example.com",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"containerOrn",
"username",
"password"
],
"type": "object"
},
"AppServiceAccountCredentials": {
"description": "Credentials for a SaaS app account",
"properties": {
"password": {
"description": "The password associated with the service account",
"format": "password",
"type": "string",
"writeOnly": true
},
"username": {
"description": "The username associated with the service account",
"example": "testuser@example.com",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"username"
],
"type": "object"
},
"AppServiceAccountForUpdate": {
"properties": {
"description": {
"description": "The description of the app service account",
"example": "This is for accessing salesforce Prod-5",
"format": "regex",
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"name": {
"description": "The user-defined name for the app service account",
"example": "salesforce Prod-5 account",
"format": "regex",
"maxLength": 50,
"minLength": 1,
"pattern": "^[\\w\\-_. ]+$",
"type": "string"
},
"ownerGroupIds": {
"description": "A list of IDs of the Okta groups who own the app service account",
"example": [
"00g57qp78yZT2XBA40g7"
],
"items": {
"type": "string"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"ownerUserIds": {
"description": "A list of IDs of the Okta users who own the app service account",
"example": [
"00u11s48P9zGW8yqm0g5"
],
"items": {
"type": "string"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
}
},
"type": "object"
},
"AppUser": {
"description": "The app user object defines a user's app-specific profile and credentials for an app",
"properties": {
"_embedded": {
"additionalProperties": {
"properties": {},
"type": "object"
},
"description": "Embedded resources related to the application user using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification",
"readOnly": true,
"type": "object"
},
"_links": {
"$ref": "#/components/schemas/LinksAppAndUser"
},
"created": {
"allOf": [
{
"$ref": "#/components/schemas/createdProperty"
},
{
"example": "2014-06-24T15:27:59.000Z"
}
]
},
"credentials": {
"$ref": "#/components/schemas/AppUserCredentials"
},
"externalId": {
"description": "The ID of the user in the target app that's linked to the Okta application user object.\nThis value is the native app-specific identifier or primary key for the user in the target app.\n\nThe `externalId` is set during import when the user is confirmed (reconciled) or during provisioning when the user is created in the target app.\nThis value isn't populated for SSO app assignments (for example, SAML or SWA) because it isn't synchronized with a target app.",
"example": "70c14cc17d3745e8a9f98d599a68329c",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Unique identifier for the Okta user",
"example": "00u11z6WHMYCGPCHCRFK",
"type": "string"
},
"lastSync": {
"description": "Timestamp of the last synchronization operation. This value is only updated for apps with the `IMPORT_PROFILE_UPDATES` or `PUSH PROFILE_UPDATES` feature.",
"example": "2014-06-24T15:27:59.000Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"lastUpdated": {
"allOf": [
{
"$ref": "#/components/schemas/lastUpdatedProperty"
},
{
"example": "2014-06-24T15:28:14.000Z"
}
]
},
"passwordChanged": {
"description": "Timestamp when the application user password was last changed",
"example": "2014-06-24T15:27:59.000Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"profile": {
"$ref": "#/components/schemas/AppUserProfile"
},
"scope": {
"description": "Indicates if the assignment is direct (`USER`) or by group membership (`GROUP`). If not specified, Okta tries to determine the scope based on the assignment type.",
"enum": [
"USER",
"GROUP"
],
"example": "USER",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/AppUserStatus"
},
"statusChanged": {
"description": "Timestamp when the application user status was last changed",
"example": "2014-06-24T15:28:14.000Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"syncState": {
"$ref": "#/components/schemas/AppUserSyncState"
}
},
"title": "Application User",
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"AppUserAssignRequest": {
"allOf": [
{
"$ref": "#/components/schemas/AppUser"
},
{
"required": [
"id"
]
}
],
"x-okta-ignore-redocly-rules-for-sdk": true
},
"AppUserCredentials": {
"description": "Specifies a user's credentials for the app.\nThis parameter can be omitted for apps with [sign-on mode](/openapi/okta-management/management/application/getapplication#application/getapplication/t=response&c=200&path=&d=0/signonmode) (`signOnMode`) or [authentication schemes](/openapi/okta-management/management/application/getapplication#application/getapplication/t=response&c=200&path=&d=0/credentials/scheme) (`credentials.scheme`) that don't require credentials.\n",
"properties": {
"password": {
"$ref": "#/components/schemas/AppUserPasswordCredential"
},
"userName": {
"description": "The user's username in the app\n\n> **Note:** The [userNameTemplate](/openapi/okta-management/management/tags/application/other/createapplication#application/createapplication/t=response&c=200&path=&d=0/credentials/usernametemplate) in the application object defines the default username generated when a user is assigned to that app.\n> If you attempt to assign a username or password to an app with an incompatible [authentication scheme](/openapi/okta-management/management/tags/application/other/createapplication#application/createapplication/t=response&c=200&path=&d=0/credentials/scheme), the following error is returned:\n> \"Credentials should not be set on this resource based on the scheme.\"",
"example": "testuser@example.com",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"AppUserCredentialsRequestPayload": {
"description": "Updates the assigned user credentials",
"properties": {
"credentials": {
"$ref": "#/components/schemas/AppUserCredentials"
}
},
"title": "Credentials",
"type": "object"
},
"AppUserPasswordCredential": {
"description": "The user's password. This is a write-only property. An empty `password` object is returned to indicate that a password value exists.",
"properties": {
"value": {
"description": "Password value",
"format": "password",
"type": "string",
"writeOnly": true
}
},
"type": "object"
},
"AppUserProfile": {
"additionalProperties": true,
"description": "Specifies the default and custom profile properties for a user.\nProperties that are visible in the Admin Console for an app assignment can also be assigned through the API.\nSome properties are reference properties that are imported from the target app and can't be configured.\nSee [profile](/openapi/okta-management/management/user/getuser#user/getuser/t=response&c=200&path=profile).\n",
"type": "object"
},
"AppUserProfileRequestPayload": {
"description": "Updates the assigned user profile\n> **Note:** The Okta API currently doesn't support entity tags for conditional updates. As long as you're the only user updating the the user profile, Okta recommends you fetch the most recent profile with [Retrieve an Application User](/openapi/okta-management/management/applicationusers#tag/ApplicationUsers/operation/getApplicationUser), apply your profile update, and then `POST` back the updated profile.",
"properties": {
"profile": {
"$ref": "#/components/schemas/AppUserProfile"
}
},
"title": "Profile",
"type": "object"
},
"AppUserStatus": {
"description": "Status of an application user",
"enum": [
"ACTIVE",
"APPROVED",
"DEPROVISIONED",
"IMPLICIT",
"IMPORTED",
"INACTIVE",
"MATCHED",
"PENDING",
"PROVISIONED",
"REVOKED",
"STAGED",
"SUSPENDED",
"UNASSIGNED"
],
"example": "ACTIVE",
"readOnly": true,
"type": "string",
"x-enumDescriptions": {
"ACTIVE": "The application user is provisioned and is enabled to use the app. This status also occurs if the app has the `IMPORT_PROFILE_UPDATES` feature enabled and user import is confirmed, or if the app doesn't have provisioning enabled.",
"APPROVED": "The application user was created but not provisioned. This status can occur when manual provisioning acknowledgment is required.",
"DEPROVISIONED": "The user was removed by the provisioning operation and the `externalId` property is unassigned.",
"IMPLICIT": "The application user is now migrated to use implicit app assignment.",
"IMPORTED": "The application user is created based on imported data.",
"INACTIVE": "The application user is provisioned, but isn't enabled to use the app. Application users in this status can be reactivated with a password reset or permanently deleted.",
"MATCHED": "The imported user is matched with an existing Application User.",
"PENDING": "The application user is provisioned, but in a pending state and can't use the app. The status moves to `ACTIVE` when the application user is activated.",
"PROVISIONED": "The background provisioning operation completed and the application user was assigned an `externalId` successfully.",
"REVOKED": "The application user is disabled and waiting for deprovisioning acknowledgment. The application user can be deleted after deprovisioning acknowledgment.",
"STAGED": "The application user doesn't have `externalId` set and the background provisioning operation is queued. This applies to apps with the `PUSH_NEW_USERS` feature enabled.",
"SUSPENDED": "The application user is provisioned, but isn't enabled to use the app. Application users in this status can be reactivated without a password reset.",
"UNASSIGNED": "The application user was imported, but the user-matching operation was skipped."
}
},
"AppUserSyncState": {
"description": "The synchronization state for the application user.\nThe application user's `syncState` depends on whether the `PROFILE_MASTERING` feature is enabled for the app.\n\n> **Note:** User provisioning currently must be configured through the Admin Console.",
"enum": [
"DISABLED",
"ERROR",
"OUT_OF_SYNC",
"SYNCHRONIZED",
"SYNCING"
],
"example": "SYNCHRONIZED",
"readOnly": true,
"type": "string",
"x-enumDescriptions": {
"DISABLED": "The provisioning feature is disabled for the app (`PROFILE_MASTERING` feature is disabled).",
"ERROR": "A background provisioning operation failed to update the user's profile in the target app. You must resolve the provisioning task in the Admin Console before you retry the operation.",
"OUT_OF_SYNC": "The Application User has changes that haven't been pushed to the target app.",
"SYNCHRONIZED": "All changes to the application user profile have successfully been synchronized with the target app.",
"SYNCING": "A background provisioning operation is running to update the user's profile in the target app."
}
},
"AppUserUpdateRequest": {
"oneOf": [
{
"$ref": "#/components/schemas/AppUserCredentialsRequestPayload"
},
{
"$ref": "#/components/schemas/AppUserProfileRequestPayload"
}
],
"x-okta-ignore-redocly-rules-for-sdk": true
},
"AppleClientSigning": {
"description": "Information used to generate the secret JSON Web Token for the token requests to Apple IdP\n> **Note:** The `privateKey` property is required for a CREATE request. For an UPDATE request, it can be null and keeps the existing value if it's null. The `privateKey` property isn't returned for LIST and GET requests or UPDATE requests if it's null.",
"properties": {
"kid": {
"description": "The key ID that you obtained from Apple when you created the private key for the client",
"example": "test key id",
"maxLength": 1024,
"type": "string"
},
"privateKey": {
"description": "The PKCS \\#8 encoded private key that you created for the client and downloaded from Apple",
"example": "MIGTAgEAMBM........Cb9PnybCnzDv+3cWSGWqpAIsQQZ",
"maxLength": 1024,
"type": "string"
},
"teamId": {
"description": "The Team ID associated with your Apple developer account",
"example": "test team id",
"maxLength": 1024,
"type": "string"
}
},
"type": "object"
},
"Application": {
"discriminator": {
"mapping": {
"AUTO_LOGIN": "#/components/schemas/AutoLoginApplication",
"BASIC_AUTH": "#/components/schemas/BasicAuthApplication",
"BOOKMARK": "#/components/schemas/BookmarkApplication",
"BROWSER_PLUGIN": "#/components/schemas/BrowserPluginApplication",
"OPENID_CONNECT": "#/components/schemas/OpenIdConnectApplication",
"SAML_1_1": "#/components/schemas/Saml11Application",
"SAML_2_0": "#/components/schemas/SamlApplication",
"SECURE_PASSWORD_STORE": "#/components/schemas/SecurePasswordStoreApplication",
"WS_FEDERATION": "#/components/schemas/WsFederationApplication"
},
"propertyName": "signOnMode"
},
"properties": {
"_embedded": {
"description": "Embedded resources related to the app using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. If the `expand=user/{userId}` query parameter is specified, then the assigned [Application User](/openapi/okta-management/management/tags/applicationusers) is embedded.",
"properties": {
"user": {
"additionalProperties": {
"properties": {},
"type": "object"
},
"description": "The specified [Application User](/openapi/okta-management/management/tags/applicationusers) assigned to the app",
"type": "object"
}
},
"readOnly": true,
"type": "object"
},
"_links": {
"$ref": "#/components/schemas/ApplicationLinks"
},
"accessibility": {
"$ref": "#/components/schemas/ApplicationAccessibility"
},
"created": {
"description": "Timestamp when the application object was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"expressConfiguration": {
"$ref": "#/components/schemas/ApplicationExpressConfiguration"
},
"features": {
"description": "Enabled app features\n> **Note:** See [Application Features](/openapi/okta-management/management/tags/applicationfeatures/) for app provisioning features.\n",
"items": {
"enum": [
"GROUP_PUSH",
"IMPORT_NEW_USERS",
"IMPORT_PROFILE_UPDATES",
"IMPORT_USER_SCHEMA",
"PROFILE_MASTERING",
"PUSH_NEW_USERS",
"PUSH_PASSWORD_UPDATES",
"PUSH_PROFILE_UPDATES",
"PUSH_USER_DEACTIVATION",
"REACTIVATE_USERS",
"OUTBOUND_DEL_AUTH",
"DESKTOP_SSO",
"FEDERATED_PROFILE",
"SUPPRESS_ACTIVATION_EMAIL",
"PUSH_PENDING_USERS",
"MFA",
"UPDATE_EXISTING_USERNAME",
"EXCLUDE_USERNAME_UPDATE_ON_PROFILE_PUSH",
"EXCHANGE_ACTIVE_SYNC",
"IMPORT_SYNC",
"IMPORT_SYNC_CONTACTS",
"DEVICE_COMPLIANCE",
"VPN_CONFIG",
"IMPORT_SCHEMA_ENUM_VALUES",
"SCIM_PROVISIONING",
"DEVICE_FILTER_IN_SIGN_ON_RULES",
"PROFILE_TEMPLATE_UPGRADE",
"DEFAULT_PUSH_STATUS_TO_PUSH",
"REAL_TIME_SYNC",
"SSO",
"AUTHN_CONTEXT",
"JIT_PROVISIONING",
"GROUP_SYNC",
"OPP_SCIM_INCREMENTAL_IMPORTS",
"IN_MEMORY_APP_USER",
"LOG_STREAMING",
"OAUTH_INTEGRATION",
"IDP",
"PUSH_NEW_USERS_WITHOUT_PASSWORD",
"SKYHOOK_SERVICE",
"ENTITLEMENT_MANAGEMENT",
"PUSH_NEW_USERS_WITH_HASHED_PASSWORD"
],
"type": "string",
"x-enumDescriptions": {
"AUTHN_CONTEXT": "Apps support establishing an authentication context based on claims from an IdP",
"DEFAULT_PUSH_STATUS_TO_PUSH": "App defaults Push status to `PUSH`. This feature is for apps, such as SharePoint, that want to receive App User profile updates even though they didn't implement traditional PUSH_PROFILE_UPDATES in the client API.",
"DESKTOP_SSO": "Okta user authentication requests are handled by desktop SSO negotiation (if possible)",
"DEVICE_COMPLIANCE": "Apps support device compliance rules",
"DEVICE_FILTER_IN_SIGN_ON_RULES": "App supports filtering by client type in app sign-on rules",
"ENTITLEMENT_MANAGEMENT": "Marker to showcase which OIN apps are entitlement enabled",
"EXCHANGE_ACTIVE_SYNC": "App supports synchronizing credentials with OMM enrolled devices",
"EXCLUDE_USERNAME_UPDATE_ON_PROFILE_PUSH": "Exclude username update during profile push",
"FEDERATED_PROFILE": "App user profiles are synchronized at sign-in and profile-view instances instead of during bulk imports",
"GROUP_PUSH": "Creates or links a group in the app when a mapping is defined for a group in Okta. Okta is the source for group memberships and all group members in Okta who are also assigned to the app are synced as group members to the app.",
"GROUP_SYNC": "Apps support syncing group information based on claims from an IdP",
"IDP": "Apps support IdP functionalities",
"IMPORT_NEW_USERS": "Creates or links a user in Okta to a user from the app",
"IMPORT_PROFILE_UPDATES": "Updates a linked user's app profile during manual or scheduled imports",
"IMPORT_SCHEMA_ENUM_VALUES": "App supports downloading schema enum values. You can download custom objects and integrating them with UD without being tied to the type metadata system.",
"IMPORT_SYNC": "Synchronize import events",
"IMPORT_SYNC_CONTACTS": "Synchronize contacts",
"IMPORT_USER_SCHEMA": "Discovers the profile schema for a user from the app automatically",
"IN_MEMORY_APP_USER": "Apps support in-memory app users. This feature is used as an alternative to Implicit App Assignment for a non-persisted app user.",
"JIT_PROVISIONING": "Apps support provisioning a user based on claims from an IdP",
"LOG_STREAMING": "Apps support log streaming",
"MFA": "App can verify credentials as a second factor",
"OAUTH_INTEGRATION": "App is an OAuth 2.0 integration",
"OPP_SCIM_INCREMENTAL_IMPORTS": "Apps support incremental imports. Used for SCIM app instances",
"OUTBOUND_DEL_AUTH": "Okta user authentication requests are delegated to a third-party app",
"PROFILE_MASTERING": "Designates the app as the identity lifecycle and profile attribute authority for linked users. The user's profile in Okta is read-only.",
"PROFILE_TEMPLATE_UPGRADE": "App supports profile template upgrades. This is primarily to help roll out the profile template upgrade feature for individual apps",
"PUSH_NEW_USERS": "Creates or links a user account in the app when assigning the app to a user in Okta",
"PUSH_NEW_USERS_WITHOUT_PASSWORD": "Don't send generated password for new users",
"PUSH_NEW_USERS_WITH_HASHED_PASSWORD": "Send hashed password for new users. This feature is only used for CIS to CIC migration.",
"PUSH_PASSWORD_UPDATES": "Updates the user's app password when their password changes in Okta",
"PUSH_PENDING_USERS": "Users are in PENDING state in Okta and are created but not active in the sourced app user",
"PUSH_PROFILE_UPDATES": "Updates a user's profile in the app when the user's profile changes in Okta (the profile source)",
"PUSH_USER_DEACTIVATION": "Deactivates a user's account in the app when unassigned from the app in Okta or deactivated",
"REACTIVATE_USERS": "Reactivates an existing inactive user when provisioning a user to the app",
"REAL_TIME_SYNC": "Apps support real-time synchronization",
"SCIM_PROVISIONING": "App supports generic SCIM client provisioning and can leverage SCIM standard for provisioning and push custom attributes to a third-party app",
"SKYHOOK_SERVICE": "Use the Skyhook microservice for LCM operations",
"SSO": "Apps support establishing a subject based on claims from an IdP",
"SUPPRESS_ACTIVATION_EMAIL": "Activation emails aren't sent to users sourced by AD and orgs with DelAuth enabled",
"UPDATE_EXISTING_USERNAME": "App can update the user name for existing users",
"VPN_CONFIG": "App supports pushing VPN configuration to OMM enrolled devices"
}
},
"readOnly": true,
"type": "array"
},
"id": {
"description": "Unique ID for the app instance",
"readOnly": true,
"type": "string"
},
"label": {
"$ref": "#/components/schemas/ApplicationLabel"
},
"lastUpdated": {
"description": "Timestamp when the application object was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"licensing": {
"$ref": "#/components/schemas/ApplicationLicensing"
},
"orn": {
"description": "The Okta resource name (ORN) for the current app instance",
"readOnly": true,
"type": "string"
},
"profile": {
"additionalProperties": true,
"description": "Contains any valid JSON schema for specifying properties that can be referenced from a request (only available to OAuth 2.0 client apps).\nFor example, add an app manager contact email address or define an allowlist of groups that you can then reference using the Okta Expression Language `getFilteredGroups` function.\n\n> **Notes:**\n> * `profile` isn't encrypted, so don't store sensitive data in it.\n> * `profile` doesn't limit the level of nesting in the JSON schema you created, but there is a practical size limit. Okta recommends a JSON schema size of 1 MB or less for best performance.",
"type": "object"
},
"signOnMode": {
"$ref": "#/components/schemas/ApplicationSignOnMode"
},
"status": {
"$ref": "#/components/schemas/ApplicationLifecycleStatus"
},
"universalLogout": {
"$ref": "#/components/schemas/ApplicationUniversalLogout"
},
"visibility": {
"$ref": "#/components/schemas/ApplicationVisibility"
}
},
"required": [
"signOnMode",
"label"
],
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"ApplicationAccessibility": {
"description": "Specifies access settings for the app",
"properties": {
"errorRedirectUrl": {
"description": "Custom error page URL for the app",
"type": "string"
},
"loginRedirectUrl": {
"description": "Custom login page URL for the app\n> **Note:** The `loginRedirectUrl` property is deprecated in Identity Engine. This property is used with the custom app login feature. Orgs that actively use this feature can continue to do so. See [Okta-hosted sign-in (redirect authentication)](https://developer.okta.com/docs/guides/redirect-authentication/) or [configure IdP routing rules](https://help.okta.com/okta_help.htm?type=oie&id=ext-cfg-routing-rules) to redirect users to the appropriate sign-in app for orgs that don't use the custom app login feature.",
"type": "string"
},
"selfService": {
"description": "Represents whether the app can be self-assignable by users",
"type": "boolean"
}
},
"type": "object"
},
"ApplicationCapability": {
"description": "Capabilities supported by the app",
"enum": [
"PROVISIONING",
"SSO",
"UNIVERSAL_LOGOUT"
],
"type": "string"
},
"ApplicationCredentials": {
"description": "Credentials for the specified `signOnMode`",
"properties": {
"signing": {
"$ref": "#/components/schemas/ApplicationCredentialsSigning"
},
"userNameTemplate": {
"$ref": "#/components/schemas/ApplicationCredentialsUsernameTemplate"
}
},
"type": "object"
},
"ApplicationCredentialsOAuthClient": {
"properties": {
"autoKeyRotation": {
"default": true,
"description": "Requested key rotation mode",
"type": "boolean"
},
"client_id": {
"description": "Unique identifier for the OAuth 2.0 client app\n\n> **Notes:**\n> * If you don't specify the `client_id`, this immutable property is populated with the [Application instance ID](/openapi/okta-management/management/application/replaceapplication#application/replaceapplication/t=response&c=200&path=&d=0/id).\n> * The `client_id` must consist of alphanumeric characters or the following special characters: `$-_.+!*'(),`.\n> * You can't use the reserved word `ALL_CLIENTS`.",
"maxLength": 100,
"minLength": 6,
"type": "string"
},
"client_secret": {
"description": "OAuth 2.0 client secret string (used for confidential clients)\n\n> **Notes:** If a `client_secret` isn't provided on creation, and the `token_endpoint_auth_method` requires one, Okta generates a random `client_secret` for the client app.\n> The `client_secret` is only shown when an OAuth 2.0 client app is created or updated (and only if the `token_endpoint_auth_method` requires a client secret).",
"maxLength": 100,
"minLength": 14,
"type": "string"
},
"pkce_required": {
"default": true,
"description": "Requires Proof Key for Code Exchange (PKCE) for additional verification. If `token_endpoint_auth_method` is `none`, then `pkce_required` must be `true`. The default is `true` for browser and native app types.",
"type": "boolean"
},
"token_endpoint_auth_method": {
"$ref": "#/components/schemas/OAuthEndpointAuthenticationMethod"
}
},
"type": "object"
},
"ApplicationCredentialsScheme": {
"description": "Apps with `BASIC_AUTH`, `BROWSER_PLUGIN`, or `SECURE_PASSWORD_STORE` sign-on modes have credentials vaulted by Okta and can be configured with the following schemes.\n",
"enum": [
"ADMIN_SETS_CREDENTIALS",
"EDIT_PASSWORD_ONLY",
"EDIT_USERNAME_AND_PASSWORD",
"EXTERNAL_PASSWORD_SYNC",
"SHARED_USERNAME_AND_PASSWORD"
],
"type": "string",
"x-enumDescriptions": {
"ADMIN_SETS_CREDENTIALS": "Admin sets username and password",
"EDIT_PASSWORD_ONLY": "Admin sets username, user sets password",
"EDIT_USERNAME_AND_PASSWORD": "User sets username and password",
"EXTERNAL_PASSWORD_SYNC": "Admin sets username, password is the same as user's Okta password",
"SHARED_USERNAME_AND_PASSWORD": "Users share a single username and password set by the admin"
}
},
"ApplicationCredentialsSigning": {
"description": "App signing key properties\n> **Note:** Only apps with SAML_2_0, SAML_1_1, WS_FEDERATION, or OPENID_CONNECT `signOnMode` support the key rotation feature.\n",
"properties": {
"kid": {
"description": "Key identifier used for signing assertions\n> **Note:** Currently, only the X.509 JWK format is supported for apps with SAML_2_0 `signOnMode`.",
"type": "string"
},
"lastRotated": {
"description": "Timestamp when the signing key was last rotated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"nextRotation": {
"description": "The scheduled time for the next signing key rotation",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"rotationMode": {
"description": "The mode of key rotation",
"type": "string"
},
"use": {
"$ref": "#/components/schemas/ApplicationCredentialsSigningUse"
}
},
"type": "object"
},
"ApplicationCredentialsSigningUse": {
"description": "Specifies the intended use of the key",
"enum": [
"sig"
],
"type": "string"
},
"ApplicationCredentialsUsernameTemplate": {
"description": "The template used to generate the username when the app is assigned through a group or directly to a user",
"properties": {
"pushStatus": {
"description": "Determines if the username is pushed to the app on updates for CUSTOM `type`",
"enum": [
"PUSH",
"DONT_PUSH",
"NOT_CONFIGURED"
],
"type": "string"
},
"template": {
"default": "${source.login}",
"description": "Mapping expression used to generate usernames.\n\nThe following are supported mapping expressions that are used with the `BUILT_IN` template type:\n\n| Name | Template Expression |\n| ------------------------------- | ---------------------------------------------- |\n| AD Employee ID | `${source.employeeID}` |\n| AD SAM Account Name | `${source.samAccountName}` |\n| AD SAM Account Name (lowercase) | `${fn:toLowerCase(source.samAccountName)}` |\n| AD User Principal Name | `${source.userName}` |\n| AD User Principal Name prefix | `${fn:substringBefore(source.userName, \"@\")}` |\n| Email | `${source.email}` |\n| Email (lowercase) | `${fn:toLowerCase(source.email)}` |\n| Email prefix | `${fn:substringBefore(source.email, \"@\")}` |\n| LDAP UID + custom suffix | `${source.userName}${instance.userSuffix}` |\n| Okta username | `${source.login}` |\n| Okta username prefix | `${fn:substringBefore(source.login, \"@\")}` |",
"type": "string"
},
"type": {
"default": "BUILT_IN",
"description": "Type of mapping expression. Empty string is allowed.",
"enum": [
"NONE",
"BUILT_IN",
"CUSTOM"
],
"type": "string"
},
"userSuffix": {
"description": "An optional suffix appended to usernames for `BUILT_IN` mapping expressions",
"type": "string"
}
},
"type": "object"
},
"ApplicationExpressConfiguration": {
"description": "
\nA `NEXT` Key is the next Key that the authorization server uses to sign tokens when Keys are rotated. The `NEXT` Key might not be listed if it hasn't been generated.\nAn `EXPIRED` Key is the previous Key that the authorization server used to sign tokens. The `EXPIRED` Key might not be listed if no Key has expired or the expired Key was deleted.",
"type": "string"
},
"use": {
"description": "Acceptable use of the key. Valid value: `sig`",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AuthorizationServerPolicy": {
"allOf": [
{
"properties": {
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/LinksSelfAndLifecycle"
},
{
"properties": {
"rules": {
"allOf": [
{
"description": "Link to the authorization server policy's rules"
},
{
"$ref": "#/components/schemas/HrefObject"
}
]
}
},
"type": "object"
}
]
},
"conditions": {
"$ref": "#/components/schemas/AuthorizationServerPolicyConditions"
},
"created": {
"description": "Timestamp when the Policy was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Description of the Policy",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"id": {
"description": "ID of the Policy",
"type": "string"
},
"lastUpdated": {
"description": "Timestamp when the Policy was last updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the Policy",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"priority": {
"description": "Specifies the order in which this Policy is evaluated in relation to the other Policies in a custom authorization server",
"type": "integer"
},
"status": {
"description": "Specifies whether requests have access to this Policy",
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"system": {
"description": "Specifies whether Okta created this Policy",
"type": "boolean"
},
"type": {
"description": "Indicates that the Policy is an authorization server Policy",
"enum": [
"OAUTH_AUTHORIZATION_POLICY"
],
"type": "string"
}
},
"type": "object"
}
],
"x-okta-ignore-redocly-rules-for-sdk": true
},
"AuthorizationServerPolicyConditions": {
"properties": {
"clients": {
"$ref": "#/components/schemas/ClientPolicyCondition"
}
},
"type": "object"
},
"AuthorizationServerPolicyPeopleCondition": {
"description": "Identifies Users and Groups that are used together",
"properties": {
"groups": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRuleGroupCondition"
},
"users": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRuleUserCondition"
}
},
"type": "object"
},
"AuthorizationServerPolicyRule": {
"properties": {
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/LinksSelfAndLifecycle"
}
]
},
"actions": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRuleActions"
},
"conditions": {
"$ref": "#/components/schemas/AuthorizationServerPolicyRuleConditions"
},
"created": {
"description": "Timestamp when the rule was created",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Identifier of the rule",
"readOnly": true,
"type": "string"
},
"lastUpdated": {
"description": "Timestamp when the rule was last modified",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the rule",
"type": "string"
},
"priority": {
"description": "Priority of the rule",
"type": "integer"
},
"status": {
"description": "Status of the rule",
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"system": {
"description": "Set to `true` for system rules. You can't delete system rules.",
"type": "boolean"
},
"type": {
"description": "Rule type",
"enum": [
"RESOURCE_ACCESS"
],
"type": "string"
}
},
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"AuthorizationServerPolicyRuleActions": {
"allOf": [
{
"$ref": "#/components/schemas/PolicyRuleActions"
},
{
"properties": {
"token": {
"$ref": "#/components/schemas/TokenAuthorizationServerPolicyRuleAction"
}
},
"type": "object"
}
]
},
"AuthorizationServerPolicyRuleConditions": {
"properties": {
"grantTypes": {
"$ref": "#/components/schemas/GrantTypePolicyRuleCondition"
},
"people": {
"$ref": "#/components/schemas/AuthorizationServerPolicyPeopleCondition"
},
"scopes": {
"$ref": "#/components/schemas/OAuth2ScopesMediationPolicyRuleCondition"
}
},
"type": "object"
},
"AuthorizationServerPolicyRuleGroupCondition": {
"description": "Specifies a set of Groups whose Users are to be included",
"properties": {
"include": {
"description": "Groups to be included",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AuthorizationServerPolicyRuleRequest": {
"allOf": [
{
"$ref": "#/components/schemas/AuthorizationServerPolicyRule"
},
{
"required": [
"name",
"conditions",
"type"
],
"type": "object"
}
],
"x-okta-ignore-redocly-rules-for-sdk": true
},
"AuthorizationServerPolicyRuleUserCondition": {
"description": "Specifies a set of Users to be included",
"properties": {
"include": {
"description": "Users to be included",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AuthorizationServerResourceHrefObject": {
"properties": {
"href": {
"description": "Link URI",
"example": "https://{yourOktaDomain}/api/v1/authorizationServers/ausain6z9zIedDCxB0h7",
"type": "string"
},
"title": {
"description": "Link name",
"example": "Example Authorization Server",
"type": "string"
}
},
"type": "object"
},
"AutoAssignAdminAppSetting": {
"description": "The org setting that automatically assigns the Okta Admin Console when an admin role is assigned",
"properties": {
"autoAssignAdminAppSetting": {
"description": "Automatically assigns the Okta Admin Console to the user when an admin role is assigned",
"type": "boolean"
}
},
"type": "object"
},
"AutoLoginApplication": {
"allOf": [
{
"$ref": "#/components/schemas/Application"
},
{
"properties": {
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
},
"name": {
"description": "A unique key is generated for the custom SWA app instance when you use AUTO_LOGIN `signOnMode`.",
"readOnly": true,
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/AutoLoginApplicationSettings"
}
},
"type": "object"
}
]
},
"AutoLoginApplicationSettings": {
"allOf": [
{
"$ref": "#/components/schemas/ApplicationSettings"
},
{
"properties": {
"signOn": {
"$ref": "#/components/schemas/AutoLoginApplicationSettingsSignOn"
}
},
"type": "object"
}
]
},
"AutoLoginApplicationSettingsSignOn": {
"properties": {
"loginUrl": {
"description": "Primary URL of the sign-in page for this app",
"type": "string"
},
"redirectUrl": {
"description": "Secondary URL of the sign-in page for this app",
"type": "string"
}
},
"required": [
"loginUrl"
],
"type": "object"
},
"AutoUpdateSchedule": {
"description": "The schedule of auto-update configured by the admin",
"properties": {
"cron": {
"description": "The schedule of the update in cron format. The cron settings are limited to only the day of the month or the nth-day-of-the-week configurations. For example, `0 8 ? * 6#3` indicates every third Saturday at 8:00 AM.",
"example": "0 8 ? * 6#3",
"type": "string"
},
"delay": {
"description": "Delay in days",
"type": "integer"
},
"duration": {
"description": "Duration in minutes",
"example": 120,
"type": "integer"
},
"lastUpdated": {
"description": "Timestamp when the update finished (only for a successful or failed update, not for a cancelled update). Null is returned if the job hasn't finished once yet.",
"format": "date-time",
"type": "string"
},
"timezone": {
"description": "Timezone of where the scheduled job takes place",
"example": "America/New_York",
"type": "string"
}
},
"type": "object"
},
"AvailableAction": {
"properties": {
"id": {
"description": "Action identifier",
"example": "okta:action1",
"type": "string"
},
"provider": {
"$ref": "#/components/schemas/WorkflowAvailableActionProvider"
}
},
"required": [
"id",
"provider"
],
"type": "object"
},
"AvailableActionProvider": {
"discriminator": {
"mapping": {
"WORKFLOWS": "#/components/schemas/WorkflowAvailableActionProvider"
},
"propertyName": "type"
},
"properties": {
"actionName": {
"description": "The name of the action flow",
"type": "string"
},
"externalId": {
"description": "The unique identifier of the action flow in the provider system",
"type": "string"
},
"link": {
"description": "The URL to the action flow interface in Workflows platform",
"format": "uri",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ActionProviderPayloadType"
}
},
"required": [
"actionName",
"link",
"externalId",
"type"
],
"type": "object"
},
"AvailableActions": {
"properties": {
"actions": {
"items": {
"$ref": "#/components/schemas/AvailableAction"
},
"type": "array"
}
},
"type": "object"
},
"AwsAccountId": {
"description": "Your AWS account ID",
"example": 123456789012,
"maxLength": 12,
"minLength": 12,
"type": "string"
},
"AwsEventSourceName": {
"description": "An alphanumeric name (no spaces) to identify this event source in AWS EventBridge",
"example": "your-event-source-name",
"maxLength": 75,
"minLength": 1,
"pattern": "^[a-zA-Z0-9.\\-_]$",
"type": "string"
},
"AwsRegion": {
"description": "The destination AWS region where your event source is located",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"sa-east-1",
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2"
],
"type": "string"
},
"BASIC_SMTP_AUTH": {
"allOf": [
{
"$ref": "#/components/schemas/BaseEmailServer"
},
{
"properties": {
"password": {
"description": "The password of the user account that's used to sign in to your SMTP server",
"type": "string"
}
},
"type": "object"
}
],
"title": "BASIC_SMTP_AUTH"
},
"BASIC_SMTP_AUTH_CREATE": {
"allOf": [
{
"$ref": "#/components/schemas/BaseEmailServerCreate"
},
{
"properties": {
"password": {
"description": "The password of the user account that's used to sign in to your SMTP server",
"type": "string"
}
},
"required": [
"password"
],
"type": "object"
}
],
"title": "BASIC_SMTP_AUTH"
},
"BaseContext": {
"description": "This object contains a number of sub-objects, each of which provide some type of contextual information.",
"properties": {
"request": {
"$ref": "#/components/schemas/InlineHookRequestObject"
},
"session": {
"description": "Details of the user session",
"properties": {
"amr": {
"description": "The authentication method reference",
"items": {
"example": [
"PASSWORD"
],
"type": "string"
},
"type": "array"
},
"createdAt": {
"description": "Timestamp of when the session was created",
"example": "2019-03-28T16:45:55.000Z",
"format": "date-time",
"type": "string"
},
"expiresAt": {
"description": "Timestamp of when the session expires",
"example": "2019-03-28T21:15:23.000Z",
"format": "date-time",
"type": "string"
},
"id": {
"description": "The unique identifier for the user's session",
"example": "102LN9Bnuc4S_ewfc9BYwageA",
"type": "string"
},
"idp": {
"$ref": "#/components/schemas/SessionIdentityProvider"
},
"lastPasswordVerification": {
"description": "Timestamp of when the user was last authenticated",
"example": "2019-03-28T16:45:55.000Z",
"format": "date-time",
"type": "string"
},
"login": {
"description": "The username used to identify the user. This is often the user's email address.",
"example": "user@example.com",
"type": "string"
},
"mfaActive": {
"description": "Describes whether multifactor authentication was enabled",
"example": false,
"type": "boolean"
},
"status": {
"description": "Represents the current status of the user's session",
"example": "ACTIVE",
"type": "string"
},
"userId": {
"description": "The unique identifier for the user",
"example": "00uq8tMo3zV0OfJON0g3",
"type": "string"
}
},
"type": "object"
},
"user": {
"description": "Identifies the Okta user that the token was generated to authenticate and provides details of their Okta user profile",
"properties": {
"_links": {
"description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of the user. These links are used to discover what groups the user is a part of and what factors they have enrolled.",
"properties": {
"factors": {
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
],
"description": "URL to retrieve individual user's factor enrollments"
},
"groups": {
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
}
],
"description": "URL to retrieve the individual user's group memberships"
}
},
"type": "object"
},
"id": {
"description": "The unique identifier for the user",
"example": "00uq8tMo3zV0OfJON0g3",
"type": "string"
},
"passwordChanged": {
"description": "The timestamp when the user's password was last updated",
"example": "2018-09-11T23:19:12.000Z",
"format": "date-time",
"type": "string"
},
"profile": {
"properties": {
"firstName": {
"description": "The first name of the user",
"example": "John",
"type": "string"
},
"lastName": {
"description": "The last name of the user",
"example": "Smith",
"type": "string"
},
"locale": {
"description": "The user's default location for purposes of localizing items such as currency, date time format, numerical representations, and so on.\nA locale value is a concatenation of the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) two-letter language code, an underscore, and the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) two-letter country code. For example, `en_US` specifies the language English and country US. This value is `en_US` by default.",
"example": "en_US",
"type": "string"
},
"login": {
"description": "The username used to identify the user. This is often the user's email address.",
"example": "user@example.com",
"type": "string"
},
"timeZone": {
"description": "The user's timezone",
"example": "America/Los_Angeles",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"BaseEmailDomain": {
"properties": {
"displayName": {
"type": "string"
},
"userName": {
"type": "string"
}
},
"required": [
"displayName",
"userName"
],
"type": "object"
},
"BaseEmailServer": {
"discriminator": {
"mapping": {
"BASIC_SMTP_AUTH": "#/components/schemas/BASIC_SMTP_AUTH",
"OAUTH2_CLIENT_CREDENTIALS": "#/components/schemas/OAUTH2_CLIENT_CREDENTIALS",
"OAUTH2_JWT_BEARER_GRANT": "#/components/schemas/OAUTH2_JWT_BEARER_GRANT"
},
"propertyName": "authType"
},
"properties": {
"alias": {
"description": "Human-readable name for your SMTP server",
"example": "CustomServer1",
"type": "string"
},
"authType": {
"$ref": "#/components/schemas/SmtpAuthType"
},
"enabled": {
"description": "If `true`, all email traffic is routed through your SMTP server",
"type": "boolean"
},
"host": {
"description": "Hostname or IP address of your SMTP server",
"example": "192.168.160.1",
"type": "string"
},
"id": {
"description": "ID of your SMTP server",
"readOnly": true,
"type": "string"
},
"port": {
"description": "Port number of your SMTP server",
"example": 587,
"type": "integer"
},
"username": {
"description": "Username that's used to access your SMTP server",
"example": "some_user@domain.com",
"type": "string"
}
},
"required": [
"authType"
],
"type": "object"
},
"BaseEmailServerCreate": {
"discriminator": {
"mapping": {
"BASIC_SMTP_AUTH": "#/components/schemas/BASIC_SMTP_AUTH_CREATE",
"OAUTH2_CLIENT_CREDENTIALS": "#/components/schemas/OAUTH2_CLIENT_CREDENTIALS_CREATE",
"OAUTH2_JWT_BEARER_GRANT": "#/components/schemas/OAUTH2_JWT_BEARER_GRANT_CREATE"
},
"propertyName": "authType"
},
"properties": {
"alias": {
"description": "Human-readable name for your SMTP server",
"example": "CustomServer1",
"type": "string"
},
"authType": {
"$ref": "#/components/schemas/SmtpAuthType"
},
"enabled": {
"description": "If `true`, all email traffic is routed through your SMTP server",
"type": "boolean"
},
"host": {
"description": "Hostname or IP address of your SMTP server",
"example": "192.168.160.1",
"type": "string"
},
"id": {
"description": "ID of your SMTP server",
"readOnly": true,
"type": "string"
},
"port": {
"description": "Port number of your SMTP server",
"example": 587,
"type": "integer"
},
"username": {
"description": "Username that's used to access your SMTP server",
"example": "some_user@domain.com",
"type": "string"
}
},
"required": [
"alias",
"enabled",
"host",
"port",
"username",
"authType"
],
"type": "object"
},
"BaseToken": {
"properties": {
"claims": {
"description": "Claims included in the token. Consists of name-value pairs for each included claim. For descriptions of the claims that you can include, see the Okta [OpenID Connect and OAuth 2.0 API reference](/openapi/okta-oauth/guides/overview/#claims).",
"type": "object"
},
"token": {
"description": "The token",
"properties": {
"lifetime": {
"description": "Lifetime of the token",
"properties": {
"expiration": {
"description": "Time in seconds until the token expires",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"BasicApplicationSettings": {
"allOf": [
{
"$ref": "#/components/schemas/ApplicationSettings"
},
{
"properties": {
"app": {
"$ref": "#/components/schemas/BasicApplicationSettingsApplication"
}
},
"type": "object"
}
]
},
"BasicApplicationSettingsApplication": {
"properties": {
"authURL": {
"description": "The URL of the authenticating site for this app",
"type": "string"
},
"url": {
"description": "The URL of the sign-in page for this app",
"type": "string"
}
},
"required": [
"authURL",
"url"
],
"type": "object"
},
"BasicAuthApplication": {
"allOf": [
{
"$ref": "#/components/schemas/Application"
},
{
"properties": {
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
},
"name": {
"description": "`template_basic_auth` is the key name for a Basic Authentication scheme app instance",
"enum": [
"template_basic_auth"
],
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/BasicApplicationSettings"
}
},
"required": [
"name",
"settings"
],
"type": "object"
}
],
"x-okta-defined-as": {
"name": "template_basic_auth"
}
},
"BeforeScheduledActionPolicyRuleCondition": {
"properties": {
"duration": {
"$ref": "#/components/schemas/Duration"
},
"lifecycleAction": {
"$ref": "#/components/schemas/ScheduledUserLifecycleAction"
}
},
"type": "object"
},
"BehaviorRule": {
"discriminator": {
"mapping": {
"ANOMALOUS_ASN": "#/components/schemas/BehaviorRuleASN",
"ANOMALOUS_DEVICE": "#/components/schemas/BehaviorRuleAnomalousDevice",
"ANOMALOUS_IP": "#/components/schemas/BehaviorRuleAnomalousIP",
"ANOMALOUS_LOCATION": "#/components/schemas/BehaviorRuleAnomalousLocation",
"VELOCITY": "#/components/schemas/BehaviorRuleVelocity"
},
"propertyName": "type"
},
"properties": {
"_link": {
"$ref": "#/components/schemas/LinksSelf"
},
"created": {
"description": "Timestamp when the Behavior Detection Rule was created",
"readOnly": true,
"type": "string"
},
"id": {
"description": "ID of the Behavior Detection Rule",
"readOnly": true,
"type": "string"
},
"lastUpdated": {
"description": "Timestamp when the Behavior Detection Rule was last modified",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the Behavior Detection Rule",
"maxLength": 128,
"type": "string"
},
"status": {
"$ref": "#/components/schemas/LifecycleStatus"
},
"type": {
"$ref": "#/components/schemas/BehaviorRuleType"
}
},
"required": [
"name",
"type"
],
"title": "Behavior Detection Rule",
"type": "object"
},
"BehaviorRuleASN": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRule"
},
{
"properties": {
"settings": {
"$ref": "#/components/schemas/BehaviorRuleSettingsAnomalousASN"
}
},
"type": "object"
}
],
"x-okta-lifecycle": {
"SKUs": [],
"isGenerallyAvailable": false,
"lifecycle": "GA"
}
},
"BehaviorRuleAnomalousDevice": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRule"
},
{
"properties": {
"settings": {
"$ref": "#/components/schemas/BehaviorRuleSettingsAnomalousDevice"
}
},
"type": "object"
}
]
},
"BehaviorRuleAnomalousIP": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRule"
},
{
"properties": {
"settings": {
"$ref": "#/components/schemas/BehaviorRuleSettingsAnomalousIP"
}
},
"type": "object"
}
]
},
"BehaviorRuleAnomalousLocation": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRule"
},
{
"properties": {
"settings": {
"$ref": "#/components/schemas/BehaviorRuleSettingsAnomalousLocation"
}
},
"type": "object"
}
]
},
"BehaviorRuleSettings": {
"title": "Behavior Detection Rule Settings",
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"BehaviorRuleSettingsAnomalousASN": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRuleSettingsHistoryBased"
}
],
"x-okta-ignore-redocly-rules-for-sdk": true
},
"BehaviorRuleSettingsAnomalousDevice": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRuleSettingsHistoryBased"
}
],
"x-okta-ignore-redocly-rules-for-sdk": true
},
"BehaviorRuleSettingsAnomalousIP": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRuleSettingsHistoryBased"
},
{
"properties": {
"maxEventsUsedForEvaluation": {
"default": 50,
"maximum": 100,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
]
},
"BehaviorRuleSettingsAnomalousLocation": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRuleSettingsHistoryBased"
},
{
"properties": {
"granularity": {
"$ref": "#/components/schemas/LocationGranularity"
},
"radiusKilometers": {
"description": "Required when `granularity` is `LAT_LONG`. Radius from the provided coordinates in kilometers.",
"type": "integer"
}
},
"required": [
"granularity"
],
"type": "object"
}
]
},
"BehaviorRuleSettingsHistoryBased": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRuleSettings"
},
{
"properties": {
"maxEventsUsedForEvaluation": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"minEventsNeededForEvaluation": {
"default": 0,
"maximum": 10,
"minimum": 0,
"type": "integer"
}
},
"title": "Behavior Detection Rule Settings based on Event History",
"type": "object"
}
]
},
"BehaviorRuleSettingsVelocity": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRuleSettings"
},
{
"properties": {
"velocityKph": {
"default": 805,
"minimum": 1,
"type": "integer"
}
},
"required": [
"velocityKph"
],
"title": "Behavior Detection Rule Settings based on device velocity in kilometers per hour.",
"type": "object"
}
]
},
"BehaviorRuleType": {
"enum": [
"ANOMALOUS_DEVICE",
"ANOMALOUS_IP",
"ANOMALOUS_LOCATION",
"VELOCITY",
"ANOMALOUS_ASN"
],
"type": "string"
},
"BehaviorRuleVelocity": {
"allOf": [
{
"$ref": "#/components/schemas/BehaviorRule"
},
{
"properties": {
"settings": {
"$ref": "#/components/schemas/BehaviorRuleSettingsVelocity"
}
},
"type": "object"
}
]
},
"BindingMethod": {
"description": "The method used to bind the out-of-band channel with the primary channel.",
"enum": [
"none",
"prompt",
"transfer"
],
"type": "string"
},
"BookmarkApplication": {
"allOf": [
{
"$ref": "#/components/schemas/Application"
},
{
"properties": {
"credentials": {
"$ref": "#/components/schemas/ApplicationCredentials"
},
"name": {
"description": "`bookmark` is the key name for a Bookmark app",
"enum": [
"bookmark"
],
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/BookmarkApplicationSettings"
}
},
"required": [
"name",
"settings"
],
"type": "object"
}
],
"x-okta-defined-as": {
"name": "bookmark"
}
},
"BookmarkApplicationSettings": {
"allOf": [
{
"$ref": "#/components/schemas/ApplicationSettings"
},
{
"properties": {
"app": {
"$ref": "#/components/schemas/BookmarkApplicationSettingsApplication"
}
},
"type": "object"
}
]
},
"BookmarkApplicationSettingsApplication": {
"properties": {
"requestIntegration": {
"default": false,
"description": "Would you like Okta to add an integration for this app?",
"type": "boolean"
},
"url": {
"description": "The URL of the launch page for this app",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"BotProtectionConfiguration": {
"description": "Bot protection configuration for the org",
"properties": {
"_links": {
"$ref": "#/components/schemas/LinksSelf"
},
"enforcementType": {
"$ref": "#/components/schemas/BotProtectionEnforcementType"
},
"level": {
"$ref": "#/components/schemas/BotProtectionLevel"
},
"mode": {
"$ref": "#/components/schemas/BotProtectionMode"
},
"supportedFlows": {
"description": "An array of authentication flows that have bot protection enabled",
"items": {
"$ref": "#/components/schemas/BotProtectionSupportedFlow"
},
"type": "array"
}
},
"required": [
"level",
"mode"
],
"title": "BotProtectionConfiguration",
"type": "object"
},
"BotProtectionEnforcementType": {
"description": "The type of enforcement to trigger when a bot is detected",
"enum": [
"OKTA_CHALLENGE"
],
"type": "string",
"x-enumDescriptions": {
"OKTA_CHALLENGE": "The Okta built-in challenge mechanism"
}
},
"BotProtectionLevel": {
"description": "The sensitivity level of bot detection",
"enum": [
"ANY",
"HIGH",
"LOW",
"MEDIUM"
],
"type": "string",
"x-enumDescriptions": {
"ANY": "Always flag all requests to trigger enforcement settings, regardless of bot likeliness confidence level.",
"HIGH": "High - Flags only high-confidence bot requests. Prioritizes a frictionless user experience.",
"LOW": "Low and above - Flags low-confidence bot requests. Prioritizes a rigorous security.",
"MEDIUM": "Medium and above - Flags moderate and high-confidence bot requests. Provides a balanced experience and security."
}
},
"BotProtectionMode": {
"description": "The enforcement mode for bot protection",
"enum": [
"DISABLED",
"ENFORCED",
"LOG_ONLY"
],
"type": "string",
"x-enumDescriptions": {
"DISABLED": "Bot protection is disabled",
"ENFORCED": "Enforcement is applied to events where bots are detected",
"LOG_ONLY": "Bot detection events are logged but not enforced"
}
},
"BotProtectionSupportedFlow": {
"description": "Authentication flows that support bot protection",
"enum": [
"SIGN_IN",
"SSPR",
"SSR"
],
"type": "string",
"x-enumDescriptions": {
"SIGN_IN": "User sign-in page",
"SSPR": "Self-Service Password Recovery page",
"SSR": "Self-Service Registration page"
}
},
"BouncesRemoveListError": {
"properties": {
"emailAddress": {
"description": "An email address with a validation error",
"type": "string"
},
"reason": {
"description": "Validation error reason",
"type": "string"
}
},
"type": "object"
},
"BouncesRemoveListObj": {
"properties": {
"emailAddresses": {
"description": "A list of email addresses to remove from the email-service bounce list",
"items": {
"description": "Email address",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BouncesRemoveListResult": {
"properties": {
"errors": {
"description": "A list of emails that wasn't added to the email-bounced remove list and the error reason",
"items": {
"$ref": "#/components/schemas/BouncesRemoveListError"
},
"type": "array"
}
},
"type": "object"
},
"Brand": {
"properties": {
"agreeToCustomPrivacyPolicy": {
"description": "Consent for updating the custom privacy URL. Not required when resetting the URL.",
"type": "boolean"
},
"customPrivacyPolicyUrl": {
"default": null,
"description": "Custom privacy policy URL",
"type": "string"
},
"defaultApp": {
"$ref": "#/components/schemas/DefaultApp"
},
"emailDomainId": {
"description": "The ID of the email domain",
"type": "string"
},
"id": {
"description": "The Brand ID",
"readOnly": true,
"type": "string"
},
"isDefault": {
"description": "If `true`, the Brand is used for the Okta subdomain",
"readOnly": true,
"type": "boolean"
},
"locale": {
"$ref": "#/components/schemas/Language"
},
"name": {
"description": "The name of the Brand",
"type": "string"
},
"removePoweredByOkta": {
"default": false,
"description": "Removes \"Powered by Okta\" from the sign-in page in redirect authentication deployments, and \"\u00a9 [current year] Okta, Inc.\" from the Okta End-User Dashboard",
"type": "boolean"
}
},
"type": "object"
},
"BrandDomains": {
"description": "Defines a list of domains with a subset of the properties for each domain",
"properties": {
"domains": {
"description": "Each element of the array defines an individual domain",
"items": {
"$ref": "#/components/schemas/DomainResponse"
},
"type": "array"
}
},
"type": "object"
},
"BrandRequest": {
"properties": {
"agreeToCustomPrivacyPolicy": {
"description": "Consent for updating the custom privacy URL. Not required when resetting the URL.",
"type": "boolean"
},
"customPrivacyPolicyUrl": {
"description": "Custom privacy policy URL",
"type": "string"
},
"defaultApp": {
"$ref": "#/components/schemas/DefaultApp"
},
"emailDomainId": {
"description": "The ID of the email domain",
"type": "string"
},
"locale": {
"$ref": "#/components/schemas/Language"
},
"name": {
"description": "The name of the brand\n\n> **Note:** You can't use the reserved `DRAPP_DOMAIN_BRAND` name.",
"type": "string"
},
"removePoweredByOkta": {
"default": false,
"description": "Removes \"Powered by Okta\" from the sign-in page in redirect authentication deployments, and \"\u00a9 [current year] Okta, Inc.\" from the Okta End-User Dashboard",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"BrandWithEmbedded": {
"allOf": [
{
"$ref": "#/components/schemas/Brand"
}
],
"properties": {
"_embedded": {
"properties": {
"domains": {
"items": {
"$ref": "#/components/schemas/DomainResponse"
},
"type": "array"
},
"emailDomain": {
"$ref": "#/components/schemas/EmailDomainResponse"
},
"themes": {
"items": {
"$ref": "#/components/schemas/ThemeResponse"
},
"type": "array"
}
},
"readOnly": true,
"type": "object"
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/LinksSelf"
},
{
"properties": {
"themes": {
"$ref": "#/components/schemas/HrefObject"
}
}
}
]
}
},
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"BrowserPluginApplication": {
"allOf": [
{
"$ref": "#/components/schemas/Application"
},
{
"properties": {
"credentials": {
"$ref": "#/components/schemas/SchemeApplicationCredentials"
},
"name": {
"description": "The key name for the app definition",
"enum": [
"template_swa",
"template_swa3field"
],
"type": "string",
"x-enumDescriptions": {
"template_swa": "The key name for a SWA app instance that requires a browser plugin",
"template_swa3field": "The key name for a SWA app instance that requires a browser plugin and supports three CSS selectors"
}
},
"settings": {
"$ref": "#/components/schemas/SwaApplicationSettings"
}
},
"required": [
"name",
"settings"
],
"type": "object"
}
]
},
"BulkDeleteRequestBody": {
"properties": {
"entityType": {
"description": "The type of data to bulk delete in a session. Currently, only `USERS` is supported.",
"enum": [
"USERS"
],
"type": "string"
},
"profiles": {
"description": "Array of profiles to be deleted",
"items": {
"$ref": "#/components/schemas/IdentitySourceUserProfileForDelete"
},
"type": "array"
}
},
"type": "object"
},
"BulkGroupDeleteRequestBody": {
"properties": {
"externalIds": {
"description": "Array of external IDs of groups that need to be deleted in Okta",
"items": {
"maxLength": 255,
"type": "string"
},
"maxItems": 200,
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"BulkGroupMembershipsDeleteRequestBody": {
"properties": {
"memberships": {
"$ref": "#/components/schemas/IdentitySourceGroupMembershipsDeleteProfile"
}
},
"type": "object"
},
"BulkGroupMembershipsUpsertRequestBody": {
"properties": {
"memberships": {
"$ref": "#/components/schemas/IdentitySourceGroupMembershipsUpsertProfile"
}
},
"type": "object"
},
"BulkGroupUpsertRequestBody": {
"properties": {
"profiles": {
"description": "Array of group profiles that needs to be inserted or updated in Okta",
"items": {
"properties": {
"externalId": {
"description": "The external ID of the group that needs to be created or updated in Okta",
"maxLength": 255,
"type": "string"
},
"profile": {
"$ref": "#/components/schemas/IdentitySourceGroupProfileForUpsert"
}
},
"type": "object"
},
"maxItems": 200,
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"BulkUpsertRequestBody": {
"properties": {
"entityType": {
"description": "The type of data to upsert into the session. Currently, only `USERS` is supported.",
"enum": [
"USERS"
],
"type": "string"
},
"profiles": {
"description": "Array of user profiles to be uploaded",
"items": {
"properties": {
"externalId": {
"description": "The external ID of the entity that needs to be created or updated in Okta",
"maxLength": 512,
"type": "string"
},
"profile": {
"$ref": "#/components/schemas/IdentitySourceUserProfileForUpsert"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"BundleEntitlement": {
"description": "An entitlement in a governance bundle",
"properties": {
"_links": {
"description": "Link relations available",
"properties": {
"values": {
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
},
{
"description": "Link to the entitlement values resource"
}
]
}
},
"type": "object"
},
"description": {
"description": "The description of the role",
"type": "string"
},
"id": {
"description": "Entitlement ID",
"type": "string"
},
"name": {
"description": "The name of the role",
"type": "string"
},
"role": {
"description": "The role key",
"type": "string"
}
},
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"BundleEntitlementsResponse": {
"description": "Entitlement list for a governance bundle",
"properties": {
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/LinksSelf"
},
{
"readOnly": true
},
{
"properties": {
"bundle": {
"$ref": "#/components/schemas/BundleLink"
},
"next": {
"$ref": "#/components/schemas/HrefObjectNextLink"
}
}
}
]
},
"entitlements": {
"description": "List of bundle entitlements",
"items": {
"$ref": "#/components/schemas/BundleEntitlement"
},
"type": "array"
}
},
"type": "object",
"x-okta-ignore-redocly-rules-for-sdk": true
},
"BundleLink": {
"allOf": [
{
"$ref": "#/components/schemas/HrefObject"
},
{
"description": "Link to the bundle resource"
}
],
"x-okta-ignore-redocly-rules-for-sdk": true
},
"ByDateTimeAuthenticatorGracePeriodExpiry": {
"allOf": [
{
"$ref": "#/components/schemas/EnrollmentPolicyAuthenticatorGracePeriod"
},
{
"properties": {
"expiry": {
"description": "The expiry date for a `BY_DATE_TIME` grace period type. Valid format: `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`\n\nFor example, `2025-01-01T18:30:45.000Z`",
"type": "string"
}
},
"type": "object"
}
]
},
"BySkipCountAuthenticatorGracePeriod": {
"allOf": [
{
"$ref": "#/components/schemas/EnrollmentPolicyAuthenticatorGracePeriod"
},
{
"properties": {
"skipCount": {
"description": "The number of times the user can skip enrolling the corresponding authenticator before it becomes mandatory",
"maximum": 10,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
}
],
"x-okta-lifecycle": {
"SKUs": [],
"isGenerallyAvailable": false,
"lifecycle": "LIMITED_GA"
}
},
"CAPTCHAInstance": {
"description": "",
"properties": {
"_links": {
"$ref": "#/components/schemas/LinksSelf"
},
"id": {
"description": "The unique key for the CAPTCHA instance",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the CAPTCHA instance",
"type": "string"
},
"secretKey": {
"description": "The secret key issued from the CAPTCHA provider to perform server-side validation for a CAPTCHA token",
"type": "string",
"writeOnly": true
},
"siteKey": {
"description": "The site key issued from the CAPTCHA provider to render a CAPTCHA on a page",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CAPTCHAType"
}
},
"title": "CAPTCHAInstance",
"type": "object"
},
"CAPTCHAType": {
"description": "The type of CAPTCHA provider",
"enum": [
"HCAPTCHA",
"RECAPTCHA_V2"
],
"type": "string"
},
"CSRLinks": {
"description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available for the current status of a CSR object using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification. This object is used for dynamic discovery of related resources and lifecycle operations.",
"properties": {
"publish": {
"$ref": "#/components/schemas/HrefCsrPublishLink"
},
"self": {
"$ref": "#/components/schemas/HrefCsrSelfLink"
}
},
"readOnly": true
},
"CaepCredentialChangeEvent": {
"description": "The credential was created, changed, revoked or deleted",
"properties": {
"change_type": {
"description": "The type of action done towards the credential",
"enum": [
"create",
"revoke",
"update",
"delete"
],
"type": "string"
},
"credential_type": {
"description": "The credential type of the changed credential. It's one of the supported enum values or any other credential type supported mutually by the transmitter and the receiver.",
"enum": [
"password",
"pin",
"x509",
"fido2-platform",
"fido2-roaming",
"fido-u2f",
"verifiable-credential",
"phone-voice",
"phone-sms",
"app",
"SECURITY_QUESTION",
"SOFT_TOKEN",
"OKTA_SOFT_TOKEN",
"VIP_FACTOR",
"EMAIL_FACTOR",
"SECUREID_FACTOR",
"DUO_SECURITY",
"OKTA_VERIFY_PUSH",
"YUBIKEY_OTP_FACTOR",
"FIDO_WEBAUTHN",
"CUSTOM_APP_PUSH",
"CLAIMS_AS_FACTOR",
"HOTP_FACTOR",
"SIGNED_NONCE",
"ALL_FACTORS",
"TOTP"
],
"type": "string"
},
"event_timestamp": {
"description": "The time of the event (UNIX timestamp)",
"example": 1702448550,
"format": "int64",
"type": "integer"
},
"fido2_aaguid": {
"description": "FIDO2 Authenticator Attestation GUID",
"example": "accced6a-63f5-490a-9eea-e59bc1896cfc",
"type": "string"
},
"friendly_name": {
"description": "Credential friendly name",
"example": "John's FIDO authenticator",
"type": "string"
},
"initiating_entity": {
"description": "The entity that initiated the event",
"enum": [
"admin",
"user",
"policy",
"system"
],
"type": "string"
},
"reason_admin": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized administrative message intended for logging and auditing",
"type": "object"
}
]
},
"reason_user": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized message intended for the end user",
"type": "object"
}
]
},
"subject": {
"$ref": "#/components/schemas/SsfTransmitterSecurityEventSubject"
}
},
"required": [
"credential_type",
"change_type"
],
"type": "object"
},
"CaepDeviceComplianceChangeEvent": {
"description": "The subject's device compliance was revoked",
"properties": {
"current_status": {
"description": "Current device compliance status",
"enum": [
"compliant",
"not-compliant"
],
"example": "non-compliant",
"type": "string"
},
"event_timestamp": {
"description": "The time of the event (UNIX timestamp)",
"example": 1702448550,
"format": "int64",
"type": "integer"
},
"initiating_entity": {
"description": "The entity that initiated the event",
"enum": [
"admin",
"user",
"policy",
"system"
],
"type": "string"
},
"previous_status": {
"description": "Previous device compliance status",
"enum": [
"compliant",
"not-compliant"
],
"type": "string"
},
"reason_admin": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized administrative message intended for logging and auditing.
Either `reason_admin` or `reason_user` is required.",
"type": "object"
}
]
},
"reason_user": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized message intended for the end user.
Either `reason_admin` or `reason_user` is required.",
"type": "object"
}
]
},
"subject": {
"$ref": "#/components/schemas/SecurityEventSubject"
}
},
"required": [
"event_timestamp",
"subject",
"current_status",
"previous_status"
],
"type": "object"
},
"CaepEvent": {
"properties": {
"event_timestamp": {
"description": "The time of the event (UNIX timestamp)",
"example": 1702448550,
"format": "int64",
"type": "integer"
},
"reason_admin": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized administrative message intended for logging and auditing",
"type": "object"
}
]
},
"reason_user": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized message intended for the end user",
"type": "object"
}
]
},
"subject": {
"$ref": "#/components/schemas/SsfTransmitterSecurityEventSubject"
}
},
"type": "object"
},
"CaepSecurityEvent": {
"properties": {
"event_timestamp": {
"description": "The time of the event (UNIX timestamp)",
"example": 1702448550,
"format": "int64",
"type": "integer"
},
"initiating_entity": {
"description": "The entity that initiated the event",
"enum": [
"admin",
"user",
"policy",
"system"
],
"type": "string"
},
"reason_admin": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized administrative message intended for logging and auditing.
Either `reason_admin` or `reason_user` is required.",
"type": "object"
}
]
},
"reason_user": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized message intended for the end user.
Either `reason_admin` or `reason_user` is required.",
"type": "object"
}
]
},
"subject": {
"$ref": "#/components/schemas/SecurityEventSubject"
}
},
"required": [
"event_timestamp",
"subject"
],
"type": "object"
},
"CaepSessionRevokedEvent": {
"description": "The session of the subject was revoked",
"properties": {
"current_ip": {
"description": "Current IP of the session",
"example": "123.4.5.6",
"type": "string"
},
"current_user_agent": {
"description": "Current user agent of the session",
"example": "CurrentUserAgent",
"type": "string"
},
"event_timestamp": {
"description": "The time of the event (UNIX timestamp)",
"example": 1702448550,
"format": "int64",
"type": "integer"
},
"initiating_entity": {
"description": "The entity that initiated the event",
"enum": [
"admin",
"user",
"policy",
"system"
],
"type": "string"
},
"last_known_ip": {
"description": "Last known IP of the session",
"example": "123.4.5.6",
"type": "string"
},
"last_known_user_agent": {
"description": "Last known user agent of the session",
"example": "LastUserAgent",
"type": "string"
},
"reason_admin": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized administrative message intended for logging and auditing.
Either `reason_admin` or `reason_user` is required.",
"type": "object"
}
]
},
"reason_user": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityEventReason"
},
{
"description": "A localized message intended for the end user.
Either `reason_admin` or `reason_user` is required.",
"type": "object"
}
]
},
"subject": {
"$ref": "#/components/schemas/SecurityEventSubject"
}
},
"required": [
"event_timestamp",
"subject"
],
"type": "object"
},
"CallerContext": {
"properties": {
"managedApp": {
"description": "Indicates whether the calling application is managed. This condition can only be applied to ANDROID device assurance policies and requires its parent rule to include both the `registered` and `managed` conditions.",
"enum": [
true
],
"type": "boolean"
}
},
"type": "object",
"x-okta-lifecycle": {
"SKUs": [],
"isGenerallyAvailable": false,
"lifecycle": "EA"
}
},
"CapabilitiesCreateObject": {
"description": "Determines whether Okta assigns a new app account to each user managed by Okta.\n\nOkta doesn't create a new account if it detects that the username specified in Okta already exists in the app.\nThe user's Okta username is assigned by default.\n",
"properties": {
"lifecycleCreate": {
"$ref": "#/components/schemas/LifecycleCreateSettingObject"
}
},
"type": "object"
},
"CapabilitiesImportRulesObject": {
"description": "Defines user import rules",
"properties": {
"userCreateAndMatch": {
"$ref": "#/components/schemas/CapabilitiesImportRulesUserCreateAndMatchObject"
}
},
"type": "object"
},
"CapabilitiesImportRulesUserCreateAndMatchObject": {
"description": "Rules for matching and creating users",
"properties": {
"allowPartialMatch": {
"description": "Allows user import upon partial matching. Partial matching occurs when the first and last names of an imported user match those of an existing Okta user, even if the username or email attributes don't match.",
"type": "boolean"
},
"autoActivateNewUsers": {
"description": "If set to `true`, imported new users are automatically activated.",
"type": "boolean"
},
"autoConfirmExactMatch": {
"description": "If set to `true`, exact-matched users are automatically confirmed on activation. If set to `false`, exact-matched users need to be confirmed manually.",
"type": "boolean"
},
"autoConfirmNewUsers": {
"description": "If set to `true`, imported new users are automatically confirmed on activation. This doesn't apply to imported users that already exist in Okta.",
"type": "boolean"
},
"autoConfirmPartialMatch": {
"description": "If set to `true`, partially matched users are automatically confirmed on activation. If set to `false`, partially matched users need to be confirmed manually.",
"type": "boolean"
},
"exactMatchCriteria": {
"description": "Determines the attribute to match users",
"enum": [
"EMAIL",
"USERNAME"
],
"type": "string"
}
},
"type": "object"
},
"CapabilitiesImportSettingsObject": {
"description": "Defines import settings",
"properties": {
"schedule": {
"$ref": "#/components/schemas/ImportScheduleObject"
},
"username": {
"$ref": "#/components/schemas/ImportUsernameObject"
}
},
"type": "object"
},
"CapabilitiesInboundProvisioningObject": {
"description": "Defines the configuration for the INBOUND_PROVISIONING feature",
"properties": {
"importRules": {
"$ref": "#/components/schemas/CapabilitiesImportRulesObject"
},
"importSettings": {
"$ref": "#/components/schemas/CapabilitiesImportSettingsObject"
}
},
"required": [
"importSettings",
"importRules"
],
"title": "INBOUND_PROVISIONING",
"type": "object",
"x-okta-lifecycle": {
"isGenerallyAvailable": true,
"lifecycle": "GA"
}
},
"CapabilitiesObject": {
"description": "Defines the configurations for the USER_PROVISIONING feature",
"properties": {
"create": {
"$ref": "#/components/schemas/CapabilitiesCreateObject"
},
"update": {
"$ref": "#/components/schemas/CapabilitiesUpdateObject"
}
},
"title": "USER_PROVISIONING",
"type": "object"
},
"CapabilitiesUpdateObject": {
"description": "Determines whether updates to a user's profile are pushed to the app",
"properties": {
"lifecycleDeactivate": {
"$ref": "#/components/schemas/LifecycleDeactivateSettingObject"
},
"password": {
"$ref": "#/components/schemas/PasswordSettingObject"
},
"profile": {
"$ref": "#/components/schemas/ProfileSettingObject"
}
},
"type": "object"
},
"Capability": {
"enum": [
"API_SERVICE",
"ENTITLEMENTS",
"IDV",
"PROVISIONING",
"SSO",
"UNIVERSAL_LOGOUT"
],
"type": "string"
},
"CatalogApplication": {
"description": "An app in the OIN catalog",
"properties": {
"_links": {
"description": "Specifies link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) available using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification",
"properties": {
"logo": {
"description": "List of app logo resources",
"items": {
"$ref": "#/components/schemas/HrefObjectLogoLink"
},
"type": "array"
},
"self": {
"$ref": "#/components/schemas/HrefObjectSelfLink"
}
},
"readOnly": true,
"type": "object"
},
"category": {
"description": "Category for the app in the OIN catalog",
"example": "SOCIAL",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Description of the app in the OIN catalog",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "OIN catalog app display name",
"readOnly": true,
"type": "string"
},
"features": {
"description": "Features supported by the app. See app [features](/openapi/okta-management/management/application/listapplications#application/listapplications/t=response&c=200&path=&d=0/features).",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"id": {
"description": "ID of the app instance. Okta returns this property only for apps not in the OIN catalog.",
"readOnly": true,
"type": "string"
},
"lastUpdated": {
"description": "Timestamp when the object was last updated",
"example": "2024-09-19T23:37:37.000Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "App key name. For OIN catalog apps, this is a unique key for the app definition.",
"type": "string"
},
"signOnModes": {
"description": "Authentication mode for the app. See app [signOnMode](/openapi/okta-management/management/application/listapplications#application/listapplications/t=response&c=200&path=&d=0/signonmode).",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/CatalogApplicationStatus"
},
"verificationStatus": {
"description": "OIN verification status of the catalog app",
"example": "OKTA_VERIFIED",
"type": "string"
},
"website": {
"description": "Website of the OIN catalog app",
"type": "string"
}
},
"type": "object"
},
"CatalogApplicationStatus": {
"description": "App status",
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"ChallengeType": {
"enum": [
"http://auth0.com/oauth/grant-type/mfa-oob",
"http://auth0.com/oauth/grant-type/mfa-otp"
],
"type": "string"
},
"ChangeEnum": {
"default": "KEEP_EXISTING",
"description": "Determines whether a change in a user's password also updates the user's password in the app",
"enum": [
"CHANGE",
"KEEP_EXISTING"
],
"example": "CHANGE",
"type": "string"
},
"ChangePasswordRequest": {
"properties": {
"newPassword": {
"$ref": "#/components/schemas/PasswordCredential"
},
"oldPassword": {
"$ref": "#/components/schemas/PasswordCredential"
},
"revokeSessions": {
"default": false,
"description": "When set to `true`, revokes all user sessions, except for the current session",
"type": "boolean"
}
},
"type": "object"
},
"Channel": {
"description": "The out-of-band channel for use with authentication. Required for all `/oob-authenticate` requests and any `/challenge` request with an out-of-band authenticator.",
"enum": [
"push",
"sms",
"voice"
],
"type": "string"
},
"ChannelBinding": {
"properties": {
"required": {
"$ref": "#/components/schemas/RequiredEnum"
},
"style": {
"enum": [
"NUMBER_CHALLENGE"
],
"type": "string"
}
},
"type": "object"
},
"ChildOrg": {
"properties": {
"_links": {
"additionalProperties": true,
"description": "Specifies available link relations (see [Web Linking](https://www.rfc-editor.org/rfc/rfc8288)) using the [JSON Hypertext Application Language](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06) specification",
"readOnly": true,
"type": "object"
},
"admin": {
"$ref": "#/components/schemas/OrgCreationAdmin"
},
"created": {
"description": "Timestamp when the org was created",
"example": "2022-08-25T00:05:00.000Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"edition": {
"description": "Edition for the org. `SKU` is the only supported value.",
"enum": [
"SKU"
],
"example": "SKU",
"type": "string"
},
"id": {
"description": "Org ID",
"example": "00o1n8sbwArJ7OQRw406",
"readOnly": true,
"type": "string"
},
"lastUpdated": {
"description": "Timestamp when the org was last updated",
"example": "2022-08-25T00:05:00.000Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Unique name of the org.\nThis name appears in the HTML `