module Oktakit::Client::Apps
Public Instance Methods
Activate Application
@params id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] An empty JSON object {} @see developer.okta.com/docs/api/resources/apps.html#activate-application @example
Oktakit.activate_application('id')
# File lib/oktakit/client/apps.rb, line 94 def activate_application(id, options = {}) post("/apps/#{id}/lifecycle/activate", options) end
Add Application
@param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] All responses return the created Application. @see developer.okta.com/docs/api/resources/apps.html#add-application @example
Oktakit.add_application
# File lib/oktakit/client/apps.rb, line 15 def add_application(options = {}) post('/apps', options) end
Assign Group to Application
@params app_id [string] Application ID @params group_id [string] Group ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] All responses return the assigned Application Group. @see developer.okta.com/docs/api/resources/apps.html#assign-group-to-application @example
Oktakit.assign_group_to_application('group_id', 'app_id')
# File lib/oktakit/client/apps.rb, line 243 def assign_group_to_application(app_id, group_id, options = {}) put("/apps/#{app_id}/groups/#{group_id}", options) end
Assign User to Application for SSO
@params id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Application User @see developer.okta.com/docs/api/resources/apps.html#assign-user-to-application-for-sso @example
Oktakit.assign_user_to_application_for_sso('id')
# File lib/oktakit/client/apps.rb, line 126 def assign_user_to_application_for_sso(id, options = {}) post("/apps/#{id}/users", options) end
Assign User to Application for SSO & Provisioning
@params od [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Application User with user profile mappings applied @see developer.okta.com/docs/api/resources/apps.html#assign-user-to-application-for-sso–provisioning @example
Oktakit.assign_user_to_application_for_sso_provisioning('id')
# File lib/oktakit/client/apps.rb, line 142 def assign_user_to_application_for_sso_provisioning(id, options = {}) post("/apps/#{id}/users", options) end
Deactivate Application
@params id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] An empty JSON object {} @see developer.okta.com/docs/api/resources/apps.html#deactivate-application @example
Oktakit.deactivate_application('id')
# File lib/oktakit/client/apps.rb, line 110 def deactivate_application(id, options = {}) post("/apps/#{id}/lifecycle/deactivate", options) end
Delete Application
@params id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] An empty JSON object {} @see developer.okta.com/docs/api/resources/apps.html#delete-application @example
Oktakit.delete_application('id')
# File lib/oktakit/client/apps.rb, line 78 def delete_application(id, options = {}) delete("/apps/#{id}", options) end
Generate New Application Key Credential
@params app_id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Return the generated Application Key Credential. @see developer.okta.com/docs/api/resources/apps.html#generate-new-application-key-credential @example
Oktakit.generate_new_application_key_credential('app_id')
# File lib/oktakit/client/apps.rb, line 309 def generate_new_application_key_credential(app_id, options = {}) post("/apps/#{app_id}/credentials/keys/generate", options) end
Get Application
@params id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Fetched Application @see developer.okta.com/docs/api/resources/apps.html#get-application @example
Oktakit.get_application('id')
# File lib/oktakit/client/apps.rb, line 31 def get_application(id, options = {}) get("/apps/#{id}", options) end
Get Assigned Group for Application
@params app_id [string] Application ID @params group_id [string] Group ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Fetched Application Group @see developer.okta.com/docs/api/resources/apps.html#get-assigned-group-for-application @example
Oktakit.get_assigned_group_for_application('group_id', 'app_id')
# File lib/oktakit/client/apps.rb, line 260 def get_assigned_group_for_application(app_id, group_id, options = {}) get("/apps/#{app_id}/groups/#{group_id}", options) end
Get Assigned User for Application
@params app_id [string] Application ID @params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Application User @see developer.okta.com/docs/api/resources/apps.html#get-assigned-user-for-application @example
Oktakit.get_assigned_user_for_application('user_id', 'app_id')
# File lib/oktakit/client/apps.rb, line 159 def get_assigned_user_for_application(app_id, user_id, options = {}) get("/apps/#{app_id}/users/#{user_id}", options) end
Get Key Credential for Application
@params app_id [string] App ID @params key_id [string] Key ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Application Key Credential. @see developer.okta.com/docs/api/resources/apps.html#get-key-credential-for-application @example
Oktakit.get_key_credential_for_application('app_id', 'key_id')
# File lib/oktakit/client/apps.rb, line 342 def get_key_credential_for_application(app_id, key_id, options = {}) get("/apps/#{app_id}/credentials/keys/#{key_id}", options) end
List Applications
@param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Applications @see developer.okta.com/docs/api/resources/apps.html#list-applications @example
Oktakit.list_applications
# File lib/oktakit/client/apps.rb, line 46 def list_applications(options = {}) get('/apps', options) end
List Groups
Assigned to Application
@params id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Application Groups
@see developer.okta.com/docs/api/resources/apps.html#list-groups-assigned-to-application @example
Oktakit.list_groups_assigned_to_application('id')
# File lib/oktakit/client/apps.rb, line 276 def list_groups_assigned_to_application(id, options = {}) get("/apps/#{id}/groups", options) end
List Key Credentials for Application
@params app_id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Application Key Credential. @see developer.okta.com/docs/api/resources/apps.html#list-key-credentials-for-application @example
Oktakit.list_key_credentials_for_application('app_id')
# File lib/oktakit/client/apps.rb, line 325 def list_key_credentials_for_application(app_id, options = {}) get("/apps/#{app_id}/credentials/keys", options) end
List Users
Assigned to Application
@params id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Array<Sawyer::Resource>] Array of Application Users
@see developer.okta.com/docs/api/resources/apps.html#list-users-assigned-to-application @example
Oktakit.list_users_assigned_to_application('id')
# File lib/oktakit/client/apps.rb, line 175 def list_users_assigned_to_application(id, options = {}) get("/apps/#{id}/users", options) end
Preview SAML metadata for Application
@params app_id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] SAML metadata in XML @see developer.okta.com/docs/api/resources/apps.html#preview-saml-metadata-for-application @example
Oktakit.preview_saml_metadata_for_application('app_id')
# File lib/oktakit/client/apps.rb, line 358 def preview_saml_metadata_for_application(app_id, options = {}) get("/apps/#{app_id}/sso/saml/metadata", options) end
Remove Group from Application
@params app_id [string] Application ID @params group_id [string] Group ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] An empty JSON object {} @see developer.okta.com/docs/api/resources/apps.html#remove-group-from-application @example
Oktakit.remove_group_from_application('group_id', 'app_id')
# File lib/oktakit/client/apps.rb, line 293 def remove_group_from_application(app_id, group_id, options = {}) delete("/apps/#{app_id}/groups/#{group_id}", options) end
Remove User from Application
@params app_id [string] Application ID @params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] An empty JSON object {} @see developer.okta.com/docs/api/resources/apps.html#remove-user-from-application @example
Oktakit.remove_user_from_application('user_id', 'app_id')
# File lib/oktakit/client/apps.rb, line 226 def remove_user_from_application(app_id, user_id, options = {}) delete("/apps/#{app_id}/users/#{user_id}", options) end
Update Application
@params id [string] Application ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Updated Application @see developer.okta.com/docs/api/resources/apps.html#update-application @example
Oktakit.update_application('id')
# File lib/oktakit/client/apps.rb, line 62 def update_application(id, options = {}) put("/apps/#{id}", options) end
Update Application Credentials for Assigned User
@params app_id [string] Application ID @params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Application User @see developer.okta.com/docs/api/resources/apps.html#update-application-credentials-for-assigned-user @example
Oktakit.update_application_credentials_for_assigned_user('user_id', 'app_id')
# File lib/oktakit/client/apps.rb, line 192 def update_application_credentials_for_assigned_user(app_id, user_id, options = {}) post("/apps/#{app_id}/users/#{user_id}", options) end
Update Application Profile for Assigned User
@params app_id [string] Application ID @params user_id [string] User ID @param options [Hash] Optional. Query params for request @param options [Hash] Optional. Header params for the request. @param options [String] Optional. The content type to accept. Default application/json @param options [String] Optional. The content type for the request. Default application/json @param options [Hash] Optional. Body params for request. @return [Hash<Sawyer::Resource>] Application User with user profile mappings applied @see developer.okta.com/docs/api/resources/apps.html#update-application-profile-for-assigned-user @example
Oktakit.update_application_profile_for_assigned_user('user_id', 'app_id')
# File lib/oktakit/client/apps.rb, line 209 def update_application_profile_for_assigned_user(app_id, user_id, options = {}) post("/apps/#{app_id}/users/#{user_id}", options) end