okta.apps.read
Lists all assigned users for an app
Success
Forbidden
Not Found
Too Many Requests
[- {
- "created": "2014-06-24T15:27:59.000Z",
- "credentials": {
- "password": { },
- "userName": "testuser"
}, - "externalId": "70c14cc17d3745e8a9f98d599a68329c",
- "id": "00u11z6WHMYCGPCHCRFK",
- "lastSync": "2014-06-24T15:27:59.000Z",
- "lastUpdated": "2014-06-24T15:28:14.000Z",
- "passwordChanged": "2014-06-24T15:27:59.000Z",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "USER",
- "status": "ACTIVE",
- "statusChanged": "2014-06-24T15:28:14.000Z",
- "syncState": "SYNCHRONIZED",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "app": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "user": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.apps.manage
Assigns a user to an app with credentials and an app-specific profile. Profile mappings defined for the app are applied first before applying any profile properties that are specified in the request.
Notes:
- You need to specify the
id
and omit thecredentials
parameter in the request body only forsignOnMode
or authentication schemes (credentials.scheme
) that don't require credentials.- You can only specify profile properties that aren't defined by profile mappings when Universal Directory is enabled.
- If your SSO app requires a profile but doesn't have provisioning enabled, you need to add a profile to the request body.
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "credentials": {
- "password": {
- "value": "pa$$word"
}, - "userName": "testuser"
}, - "id": "00u11z6WHMYCGPCHCRFK",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "USER"
}
{- "created": "2014-06-24T15:27:59.000Z",
- "credentials": {
- "password": { },
- "userName": "testuser"
}, - "externalId": "70c14cc17d3745e8a9f98d599a68329c",
- "id": "00u11z6WHMYCGPCHCRFK",
- "lastSync": "2014-06-24T15:27:59.000Z",
- "lastUpdated": "2014-06-24T15:28:14.000Z",
- "passwordChanged": "2014-06-24T15:27:59.000Z",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "USER",
- "status": "ACTIVE",
- "statusChanged": "2014-06-24T15:28:14.000Z",
- "syncState": "SYNCHRONIZED",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "app": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "user": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.apps.read
Retrieves a specific user assignment for app by id
Success
Forbidden
Not Found
Too Many Requests
{- "created": "2014-06-24T15:27:59.000Z",
- "credentials": {
- "password": { },
- "userName": "testuser"
}, - "externalId": "70c14cc17d3745e8a9f98d599a68329c",
- "id": "00u11z6WHMYCGPCHCRFK",
- "lastSync": "2014-06-24T15:27:59.000Z",
- "lastUpdated": "2014-06-24T15:28:14.000Z",
- "passwordChanged": "2014-06-24T15:27:59.000Z",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "USER",
- "status": "ACTIVE",
- "statusChanged": "2014-06-24T15:28:14.000Z",
- "syncState": "SYNCHRONIZED",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "app": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "user": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.apps.manage
Updates a user's profile for an application
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "credentials": {
- "password": {
- "value": "pa$$word"
}, - "userName": "testuser"
}, - "id": "00u11z6WHMYCGPCHCRFK",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "USER"
}
{- "created": "2014-06-24T15:27:59.000Z",
- "credentials": {
- "password": { },
- "userName": "testuser"
}, - "externalId": "70c14cc17d3745e8a9f98d599a68329c",
- "id": "00u11z6WHMYCGPCHCRFK",
- "lastSync": "2014-06-24T15:27:59.000Z",
- "lastUpdated": "2014-06-24T15:28:14.000Z",
- "passwordChanged": "2014-06-24T15:27:59.000Z",
- "profile": {
- "property1": { },
- "property2": { }
}, - "scope": "USER",
- "status": "ACTIVE",
- "statusChanged": "2014-06-24T15:28:14.000Z",
- "syncState": "SYNCHRONIZED",
- "_embedded": {
- "property1": { },
- "property2": { }
}, - "_links": {
- "app": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}, - "user": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.apps.manage
Unassigns a user from an application
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": [ ]
}