The Identity Providers API provides operations to manage federations with external Identity Providers (IdP). For example, your app can support signing in with credentials from Apple, Facebook, Google, LinkedIn, Microsoft, an enterprise IdP using SAML 2.0, or an IdP using the OpenID Connect (OIDC
) protocol.
okta.idps.read
Lists all identity provider integrations with pagination. A subset of IdPs can be returned that match a supported filter expression or query.
Success
Forbidden
Too Many Requests
[- {
- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "CUSTOM_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}, - "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": null,
- "type": null,
- "version": null
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": null,
- "type": null,
- "version": null
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}, - "mapAMRClaims": false,
- "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "APPEND",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "CUSTOM_ATTRIBUTE",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "properties": {
- "additionalAmr": [
- "string"
]
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "FROM_URL"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "MTLS"
}, - "status": "ACTIVE",
- "type": "AgentlessDSSO",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.idps.manage
Creates a new identity provider integration
Success
Bad Request
Forbidden
Too Many Requests
{- "issuerMode": "CUSTOM_URL",
- "name": "string",
- "policy": {
- "description": "string",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}, - "mapAMRClaims": false,
- "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "APPEND",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "CUSTOM_ATTRIBUTE",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "properties": {
- "additionalAmr": [
- "string"
]
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "FROM_URL"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "MTLS"
}, - "status": "ACTIVE",
- "type": "AgentlessDSSO"
}
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "CUSTOM_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}, - "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}, - "mapAMRClaims": false,
- "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "APPEND",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "CUSTOM_ATTRIBUTE",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "properties": {
- "additionalAmr": [
- "string"
]
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "FROM_URL"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "MTLS"
}, - "status": "ACTIVE",
- "type": "AgentlessDSSO",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.idps.read
Lists all IdP key credentials
Success
Forbidden
Too Many Requests
[- {
- "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.idps.manage
Creates a new X.509 certificate credential to the IdP key store.
Success
Bad Request
Forbidden
Too Many Requests
{- "alg": "string",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string"
}
{- "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.idps.read
Retrieves a specific IdP Key Credential by kid
Success
Forbidden
Not Found
Too Many Requests
{- "alg": "string",
- "created": "2019-08-24T14:15:22Z",
- "e": "string",
- "expiresAt": "2019-08-24T14:15:22Z",
- "key_ops": [
- "string"
], - "kid": "string",
- "kty": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "n": "string",
- "status": "string",
- "use": "string",
- "x5c": [
- "string"
], - "x5t": "string",
- "x5t#S256": "string",
- "x5u": "string",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.idps.manage
Deletes a specific IdP Key Credential by kid
if it is not currently being used by an Active or Inactive IdP
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.idps.read
Retrieves an identity provider integration by idpId
Success
Forbidden
Not Found
Too Many Requests
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "CUSTOM_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}, - "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}, - "mapAMRClaims": false,
- "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "APPEND",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "CUSTOM_ATTRIBUTE",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "properties": {
- "additionalAmr": [
- "string"
]
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "FROM_URL"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "MTLS"
}, - "status": "ACTIVE",
- "type": "AgentlessDSSO",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.idps.manage
Replaces an identity provider integration by idpId
issuerMode | string (IssuerMode) Enum: "CUSTOM_URL" "DYNAMIC" "ORG_URL" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (IdentityProviderPolicy) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (IdentityProviderProperties) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Protocol) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string (LifecycleStatus) Enum: "ACTIVE" "INACTIVE" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string (IdentityProviderType) Enum: "AgentlessDSSO" "FACEBOOK" "GOOGLE" "IWA" "LINKEDIN" "MICROSOFT" "OIDC" "OKTA" "SAML2" "X509" |
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "issuerMode": "CUSTOM_URL",
- "name": "string",
- "policy": {
- "description": "string",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}, - "mapAMRClaims": false,
- "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "APPEND",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "CUSTOM_ATTRIBUTE",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "properties": {
- "additionalAmr": [
- "string"
]
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "FROM_URL"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "MTLS"
}, - "status": "ACTIVE",
- "type": "AgentlessDSSO"
}
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "issuerMode": "CUSTOM_URL",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "policy": {
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "priority": 0,
- "status": "ACTIVE",
- "system": true,
- "type": "ACCESS_POLICY",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}, - "accountLink": {
- "action": "AUTO",
- "filter": {
- "groups": {
- "include": [
- "string"
]
}
}
}, - "conditions": {
- "app": {
- "exclude": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
], - "include": [
- {
- "id": "string",
- "name": "string",
- "type": "APP"
}
]
}, - "apps": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "authContext": {
- "authType": "ANY"
}, - "authProvider": {
- "include": [
- "string"
], - "provider": "ACTIVE_DIRECTORY"
}, - "beforeScheduledAction": {
- "duration": {
- "number": 0,
- "unit": "string"
}, - "lifecycleAction": {
- "status": "ACTIVATING"
}
}, - "clients": {
- "include": [
- "string"
]
}, - "context": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY",
- "expression": "string"
}, - "device": {
- "migrated": true,
- "platform": {
- "supportedMDMFrameworks": [
- "AFW"
], - "types": [
- "ANDROID"
]
}, - "rooted": true,
- "trustLevel": "ANY"
}, - "grantTypes": {
- "include": [
- "string"
]
}, - "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "identityProvider": {
- "idpIds": [
- "string"
], - "provider": "ANY"
}, - "mdmEnrollment": {
- "blockNonSafeAndroid": true,
- "enrollment": "ANY_OR_NONE"
}, - "network": {
- "connection": "ANYWHERE",
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "people": {
- "groups": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}, - "users": {
- "exclude": [
- "string"
], - "include": [
- "string"
]
}
}, - "platform": {
- "exclude": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
], - "include": [
- {
- "os": {
- "expression": "string",
- "type": "ANDROID",
- "version": {
- "matchType": null,
- "value": null
}
}, - "type": "ANY"
}
]
}, - "risk": {
- "behaviors": [
- "string"
]
}, - "riskScore": {
- "level": "string"
}, - "scopes": {
- "include": [
- "string"
]
}, - "userIdentifier": {
- "attribute": "string",
- "patterns": [
- {
- "matchType": "CONTAINS",
- "value": "string"
}
], - "type": "ATTRIBUTE"
}, - "users": {
- "exclude": [
- "string"
], - "inactivity": {
- "number": 0,
- "unit": "string"
}, - "include": [
- "string"
], - "lifecycleExpiration": {
- "lifecycleStatus": "string",
- "number": 0,
- "unit": "string"
}, - "passwordExpiration": {
- "number": 0,
- "unit": "string"
}, - "userLifecycleAttribute": {
- "attributeName": "string",
- "matchingValue": "string"
}
}, - "userStatus": {
- "value": "ACTIVATING"
}
}, - "mapAMRClaims": false,
- "maxClockSkew": 0,
- "provisioning": {
- "action": "AUTO",
- "conditions": {
- "deprovisioned": {
- "action": "NONE"
}, - "suspended": {
- "action": "NONE"
}
}, - "groups": {
- "action": "APPEND",
- "assignments": [
- "string"
], - "filter": [
- "string"
], - "sourceAttributeName": "string"
}, - "profileMaster": true
}, - "subject": {
- "filter": "string",
- "format": [
- "string"
], - "matchAttribute": "string",
- "matchType": "CUSTOM_ATTRIBUTE",
- "userNameTemplate": {
- "template": "string"
}
}
}, - "properties": {
- "additionalAmr": [
- "string"
]
}, - "protocol": {
- "algorithms": {
- "request": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}, - "response": {
- "signature": {
- "algorithm": "string",
- "scope": "ANY"
}
}
}, - "credentials": {
- "client": {
- "client_id": "string",
- "client_secret": "string"
}, - "signing": {
- "kid": "string"
}, - "trust": {
- "audience": "string",
- "issuer": "string",
- "kid": "string",
- "revocation": "CRL",
- "revocationCacheLifetime": 0
}
}, - "endpoints": {
- "acs": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "authorization": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "jwks": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "metadata": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "slo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "sso": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "token": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "userInfo": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}
}, - "issuer": {
- "binding": "HTTP-POST",
- "destination": "string",
- "type": "INSTANCE",
- "url": "string"
}, - "relayState": {
- "format": "FROM_URL"
}, - "scopes": [
- "string"
], - "settings": {
- "nameFormat": "string"
}, - "type": "MTLS"
}, - "status": "ACTIVE",
- "type": "AgentlessDSSO",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.idps.manage
Deletes an identity provider integration by idpId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.idps.read
Lists all Certificate Signing Requests for an IdP
Success
Forbidden
Not Found
Too Many Requests
[- {
- "created": "2019-08-24T14:15:22Z",
- "csr": "string",
- "id": "string",
- "kty": "string"
}
]
okta.idps.manage
Generates a new key pair and returns a Certificate Signing Request for it
Created
Bad Request
Forbidden
Not Found
Too Many Requests
{- "subject": {
- "commonName": "string",
- "countryName": "string",
- "localityName": "string",
- "organizationalUnitName": "string",
- "organizationName": "string",
- "stateOrProvinceName": "string"
}, - "subjectAltNames": {
- "dnsNames": [
- "string"
]
}
}
{- "created": "2019-08-24T14:15:22Z",
- "csr": "string",
- "id": "string",
- "kty": "string"
}
okta.idps.read
Retrieves a specific Certificate Signing Request model by id