string FactorResultType

{
  "enum": [
    "SUCCESS",
    "CHALLENGE",
    "WAITING",
    "FAILED",
    "REJECTED",
    "TIMEOUT",
    "TIME_WINDOW_EXCEEDED",
    "PASSCODE_REPLAYED",
    "ERROR",
    "CANCELLED"
  ],
  "type": "string",
  "x-okta-tags": [
    "UserFactor"
  ]
}

string FactorStatus

{
  "enum": [
    "PENDING_ACTIVATION",
    "ACTIVE",
    "INACTIVE",
    "NOT_SETUP",
    "ENROLLED",
    "DISABLED",
    "EXPIRED"
  ],
  "type": "string",
  "x-okta-tags": [
    "UserFactor"
  ]
}

string FactorType

{
  "enum": [
    "call",
    "email",
    "hotp",
    "push",
    "question",
    "signed_nonce",
    "sms",
    "token:hardware",
    "token:hotp",
    "token:software:totp",
    "token",
    "u2f",
    "web",
    "webauthn"
  ],
  "type": "string",
  "x-okta-tags": [
    "UserFactor"
  ]
}

object Feature

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/FeatureType"
    },
    "stage": {
      "$ref": "#/components/schemas/FeatureStage"
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "status": {
      "$ref": "#/components/schemas/EnabledStatus"
    },
    "description": {
      "type": "string"
    }
  },
  "x-okta-crud": [
    {
      "alias": "read",
      "arguments": [],
      "operationId": "getFeature"
    }
  ],
  "x-okta-tags": [
    "Feature"
  ],
  "x-okta-operations": [
    {
      "alias": "updateLifecycle",
      "arguments": [
        {
          "src": "id",
          "dest": "featureId"
        }
      ],
      "operationId": "updateFeatureLifecycle"
    },
    {
      "alias": "getDependents",
      "arguments": [
        {
          "src": "id",
          "dest": "featureId"
        }
      ],
      "operationId": "listFeatureDependents"
    },
    {
      "alias": "getDependencies",
      "arguments": [
        {
          "src": "id",
          "dest": "featureId"
        }
      ],
      "operationId": "listFeatureDependencies"
    }
  ]
}

array FeatureGetSuccessResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Feature"
  }
}

array FeatureListDependenciesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Feature"
  }
}

array FeatureListDependentsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Feature"
  }
}

object FeatureStage

{
  "type": "object",
  "properties": {
    "state": {
      "$ref": "#/components/schemas/FeatureStageState"
    },
    "value": {
      "$ref": "#/components/schemas/FeatureStageValue"
    }
  },
  "x-okta-tags": [
    "Feature"
  ]
}

string FeatureStageState

{
  "enum": [
    "OPEN",
    "CLOSED"
  ],
  "type": "string",
  "x-okta-tags": [
    "Feature"
  ]
}

string FeatureStageValue

{
  "enum": [
    "EA",
    "BETA"
  ],
  "type": "string",
  "x-okta-tags": [
    "Feature"
  ]
}

string FeatureType

{
  "enum": [
    "self-service"
  ],
  "type": "string",
  "x-okta-tags": [
    "Feature"
  ]
}

string FipsEnum

{
  "enum": [
    "REQUIRED",
    "OPTIONAL"
  ],
  "type": "string",
  "x-okta-tags": [
    "Authenticator"
  ]
}

object ForgotPasswordResponse

{
  "properties": {
    "resetPasswordUrl": {
      "type": "string",
      "readOnly": true
    }
  },
  "x-okta-tags": [
    "User"
  ]
}

object GrantTypePolicyRuleCondition

{
  "type": "object",
  "properties": {
    "include": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object Group

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "type": {
      "$ref": "#/components/schemas/GroupType"
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "profile": {
      "$ref": "#/components/schemas/GroupProfile"
    },
    "_embedded": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "objectClass": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "readOnly": true
    },
    "lastMembershipUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-okta-crud": [
    {
      "alias": "update",
      "arguments": [
        {
          "src": "id",
          "dest": "groupId"
        },
        {
          "dest": "group",
          "self": true
        }
      ],
      "operationId": "updateGroup"
    },
    {
      "alias": "delete",
      "arguments": [
        {
          "src": "id",
          "dest": "groupId"
        }
      ],
      "operationId": "deleteGroup"
    }
  ],
  "x-okta-tags": [
    "Group"
  ],
  "x-okta-operations": [
    {
      "alias": "removeUser",
      "arguments": [
        {
          "src": "id",
          "dest": "groupId"
        }
      ],
      "operationId": "removeUserFromGroup"
    },
    {
      "alias": "listUsers",
      "arguments": [
        {
          "src": "id",
          "dest": "groupId"
        }
      ],
      "operationId": "listGroupUsers"
    },
    {
      "alias": "listApplications",
      "arguments": [
        {
          "src": "id",
          "dest": "groupId"
        }
      ],
      "operationId": "listAssignedApplicationsForGroup"
    },
    {
      "alias": "assignRole",
      "arguments": [
        {
          "src": "id",
          "dest": "groupId"
        }
      ],
      "operationId": "assignRoleToGroup"
    }
  ]
}

object GroupCondition

{
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

array GroupEnumerateGroupMembersResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/User"
  }
}

array GroupGetAllRulesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GroupRule"
  }
}

array GroupGetRoleListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Role"
  }
}

array GroupGetRoleTargetsCatalogAppsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/CatalogApplication"
  }
}

array GroupListAssignedAppsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Application"
  }
}

array GroupListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Group"
  }
}

array GroupListRoleTargetsGroupsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Group"
  }
}

object GroupPolicyRuleCondition

{
  "type": "object",
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "Policy"
  ]
}

object GroupProfile

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "Group"
  ],
  "x-okta-extensible": true
}

object GroupRule

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/GroupRuleStatus"
    },
    "actions": {
      "$ref": "#/components/schemas/GroupRuleAction"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "conditions": {
      "$ref": "#/components/schemas/GroupRuleConditions"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-okta-crud": [
    {
      "alias": "update",
      "arguments": [
        {
          "src": "id",
          "dest": "ruleId"
        },
        {
          "dest": "groupRule",
          "self": true
        }
      ],
      "operationId": "updateGroupRule"
    },
    {
      "alias": "delete",
      "arguments": [
        {
          "src": "id",
          "dest": "ruleId"
        }
      ],
      "operationId": "deleteGroupRule"
    }
  ],
  "x-okta-tags": [
    "GroupRule"
  ],
  "x-okta-operations": [
    {
      "alias": "activate",
      "arguments": [
        {
          "src": "id",
          "dest": "ruleId"
        }
      ],
      "operationId": "activateGroupRule"
    },
    {
      "alias": "deactivate",
      "arguments": [
        {
          "src": "id",
          "dest": "ruleId"
        }
      ],
      "operationId": "deactivateGroupRule"
    }
  ]
}

object GroupRuleAction

{
  "type": "object",
  "properties": {
    "assignUserToGroups": {
      "$ref": "#/components/schemas/GroupRuleGroupAssignment"
    }
  },
  "x-okta-tags": [
    "GroupRule"
  ]
}

object GroupRuleConditions

{
  "type": "object",
  "properties": {
    "people": {
      "$ref": "#/components/schemas/GroupRulePeopleCondition"
    },
    "expression": {
      "$ref": "#/components/schemas/GroupRuleExpression"
    }
  },
  "x-okta-tags": [
    "GroupRule"
  ]
}

object GroupRuleExpression

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "GroupRule"
  ]
}

object GroupRuleGroupAssignment

{
  "type": "object",
  "properties": {
    "groupIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "GroupRule"
  ]
}

object GroupRuleGroupCondition

{
  "type": "object",
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "GroupRule"
  ]
}

object GroupRulePeopleCondition

{
  "type": "object",
  "properties": {
    "users": {
      "$ref": "#/components/schemas/GroupRuleUserCondition"
    },
    "groups": {
      "$ref": "#/components/schemas/GroupRuleGroupCondition"
    }
  },
  "x-okta-tags": [
    "GroupRule"
  ]
}

string GroupRuleStatus

{
  "enum": [
    "ACTIVE",
    "INACTIVE",
    "INVALID"
  ],
  "type": "string",
  "x-okta-tags": [
    "GroupRule"
  ]
}

object GroupRuleUserCondition

{
  "type": "object",
  "properties": {
    "exclude": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "include": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "x-okta-tags": [
    "GroupRule"
  ]
}

object GroupSchema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "readOnly": true
    },
    "type": {
      "type": "string",
      "readOnly": true
    },
    "title": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "$schema": {
      "type": "string",
      "readOnly": true
    },
    "created": {
      "type": "string",
      "readOnly": true
    },
    "properties": {
      "$ref": "#/components/schemas/UserSchemaProperties"
    },
    "definitions": {
      "$ref": "#/components/schemas/GroupSchemaDefinitions"
    },
    "description": {
      "type": "string"
    },
    "lastUpdated": {
      "type": "string",
      "readOnly": true
    }
  },
  "x-okta-tags": [
    "GroupSchema"
  ]
}

object GroupSchemaAttribute

{
  "type": "object",
  "properties": {
    "enum": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "type": {
      "$ref": "#/components/schemas/UserSchemaAttributeType"
    },
    "items": {
      "$ref": "#/components/schemas/UserSchemaAttributeItems"
    },
    "oneOf": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserSchemaAttributeEnum"
      }
    },
    "scope": {
      "$ref": "#/components/schemas/UserSchemaAttributeScope"
    },
    "title": {
      "type": "string"
    },
    "union": {
      "$ref": "#/components/schemas/UserSchemaAttributeUnion"
    },
    "master": {
      "$ref": "#/components/schemas/UserSchemaAttributeMaster"
    },
    "unique": {
      "type": "string"
    },
    "required": {
      "type": "boolean"
    },
    "maxLength": {
      "type": "integer"
    },
    "minLength": {
      "type": "integer"
    },
    "mutability": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserSchemaAttributePermission"
      }
    },
    "externalName": {
      "type": "string"
    },
    "externalNamespace": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "GroupSchema"
  ]
}

object GroupSchemaBase

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "type": {
      "type": "string"
    },
    "required": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "properties": {
      "$ref": "#/components/schemas/GroupSchemaBaseProperties"
    }
  },
  "x-okta-tags": [
    "GroupSchema"
  ]
}

object GroupSchemaBaseProperties

{
  "type": "object",
  "properties": {
    "name": {
      "$ref": "#/components/schemas/GroupSchemaAttribute"
    },
    "description": {
      "$ref": "#/components/schemas/GroupSchemaAttribute"
    }
  },
  "x-okta-tags": [
    "GroupSchema"
  ]
}

object GroupSchemaCustom

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "type": {
      "type": "string"
    },
    "required": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "properties": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/GroupSchemaAttribute"
      }
    }
  },
  "x-okta-tags": [
    "GroupSchema"
  ]
}

object GroupSchemaDefinitions

{
  "type": "object",
  "properties": {
    "base": {
      "$ref": "#/components/schemas/GroupSchemaBase"
    },
    "custom": {
      "$ref": "#/components/schemas/GroupSchemaCustom"
    }
  },
  "x-okta-tags": [
    "GroupSchema"
  ]
}

string GroupType

{
  "enum": [
    "OKTA_GROUP",
    "APP_GROUP",
    "BUILT_IN"
  ],
  "type": "string",
  "x-okta-tags": [
    "Group"
  ]
}

object HardwareUserFactor

{
  "properties": {
    "profile": {
      "$ref": "#/components/schemas/HardwareUserFactorProfile"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ],
  "x-okta-parent": "#/definitions/UserFactor"
}

object HardwareUserFactorProfile

{
  "properties": {
    "credentialId": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "UserFactor"
  ]
}

object IdentityProvider

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "type": {
      "enum": [
        "SAML2",
        "GOOGLE",
        "FACEBOOK",
        "LINKEDIN",
        "MICROSOFT",
        "OIDC",
        "OKTA",
        "IWA",
        "AgentlessDSSO",
        "X509"
      ],
      "type": "string",
      "x-okta-known-values": [
        "SAML2",
        "GOOGLE",
        "FACEBOOK",
        "LINKEDIN",
        "MICROSOFT",
        "OIDC",
        "OKTA",
        "IWA",
        "AgentlessDSSO",
        "X509"
      ]
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "policy": {
      "$ref": "#/components/schemas/IdentityProviderPolicy"
    },
    "status": {
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "protocol": {
      "$ref": "#/components/schemas/Protocol"
    },
    "issuerMode": {
      "enum": [
        "ORG_URL",
        "CUSTOM_URL",
        "DYNAMIC"
      ],
      "type": "string"
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-okta-crud": [
    {
      "alias": "create",
      "arguments": [
        {
          "dest": "idpTrust",
          "self": true
        }
      ],
      "operationId": "createIdentityProvider"
    },
    {
      "alias": "read",
      "arguments": [],
      "operationId": "getIdentityProvider"
    },
    {
      "alias": "update",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        },
        {
          "dest": "idpTrust",
          "self": true
        }
      ],
      "operationId": "updateIdentityProvider"
    },
    {
      "alias": "delete",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "deleteIdentityProvider"
    }
  ],
  "x-okta-tags": [
    "IdentityProvider"
  ],
  "x-okta-operations": [
    {
      "alias": "listSigningCsrs",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "listCsrsForIdentityProvider"
    },
    {
      "alias": "generateCsr",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "generateCsrForIdentityProvider"
    },
    {
      "alias": "deleteSigningCsr",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "revokeCsrForIdentityProvider"
    },
    {
      "alias": "getSigningCsr",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "getCsrForIdentityProvider"
    },
    {
      "alias": "listSigningKeys",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "listIdentityProviderSigningKeys"
    },
    {
      "alias": "generateSigningKey",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "generateIdentityProviderSigningKey"
    },
    {
      "alias": "getSigningKey",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "getIdentityProviderSigningKey"
    },
    {
      "alias": "cloneKey",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "cloneIdentityProviderKey"
    },
    {
      "alias": "activate",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "activateIdentityProvider"
    },
    {
      "alias": "deactivate",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "deactivateIdentityProvider"
    },
    {
      "alias": "listUsers",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "listIdentityProviderApplicationUsers"
    },
    {
      "alias": "unlinkUser",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "unlinkUserFromIdentityProvider"
    },
    {
      "alias": "getUser",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "getIdentityProviderApplicationUser"
    },
    {
      "alias": "linkUser",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "linkUserToIdentityProvider"
    },
    {
      "alias": "listSocialAuthTokens",
      "arguments": [
        {
          "src": "id",
          "dest": "idpId"
        }
      ],
      "operationId": "listSocialAuthTokens"
    }
  ]
}

object IdentityProviderApplicationUser

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "created": {
      "type": "string"
    },
    "profile": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    },
    "_embedded": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "object"
      }
    },
    "externalId": {
      "type": "string"
    },
    "lastUpdated": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "IdentityProvider"
  ]
}

object IdentityProviderCredentials

{
  "type": "object",
  "properties": {
    "trust": {
      "$ref": "#/components/schemas/IdentityProviderCredentialsTrust"
    },
    "client": {
      "$ref": "#/components/schemas/IdentityProviderCredentialsClient"
    },
    "signing": {
      "$ref": "#/components/schemas/IdentityProviderCredentialsSigning"
    }
  },
  "x-okta-tags": [
    "IdentityProvider"
  ]
}

object IdentityProviderCredentialsClient

{
  "type": "object",
  "properties": {
    "client_id": {
      "type": "string"
    },
    "client_secret": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "IdentityProvider"
  ]
}

object IdentityProviderCredentialsSigning

{
  "type": "object",
  "properties": {
    "kid": {
      "type": "string"
    },
    "teamId": {
      "type": "string"
    },
    "privateKey": {
      "type": "string"
    }
  },
  "x-okta-tags": [
    "IdentityProvider"
  ]
}

object IdentityProviderCredentialsTrust

{
  "type": "object",
  "properties": {
    "kid": {
      "type": "string"
    },
    "issuer": {
      "type": "string"
    },
    "audience": {
      "type": "string"
    },
    "revocation": {
      "enum": [
        "CRL",
        "DELTA_CRL",
        "OCSP"
      ],
      "type": "string"
    },
    "revocationCacheLifetime": {
      "type": "integer"
    }
  },
  "x-okta-tags": [
    "IdentityProvider"
  ]
}

array IdentityProviderEnumerateIdpKeysResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/JsonWebKey"
  }
}