1. Role And Permission
  • Overview
  • Application Guides
    • Frontend
      • Get Started - React App
      • Get Started - HTML and JS
      • Get Started - Angular JS
      • Get Started - Next JS App
    • Backend
      • Get Started - Node JS
      • Get Started - Golang
      • Get Started - ASP.NET
      • Get Started - JAVA
  • Dashboard
    • API Credentials
    • Organization
    • Social Login
    • Customize Email Template
    • Configure Custom Domain
    • IT Admin Portal
  • Authentication
    • Login Widget
    • Magic Link
    • Google Social Login
    • Multi-Factor Authentication
    • Single Sign-On Overview
    • Setup SSO Connection
  • Security
    • Overview
    • Authentication
      • Password Hashing and Storage
      • Multi-Factor Authentication Methods and Implementation
      • Session Management
    • Attack Protection
      • Bot Detection
      • Breached Password Detection
      • Brute Force Protection
      • Log Events
      • Secure JSON Web Tokens (JWT)
      • Secure OpenID Connect (OIDC)
      • Suspicious IP Throttling
    • Data Security
      • Data Encryption At Rest and In Transit
      • Secure Storage of Secrets (Keys, Credentials)
      • Sensitive Data Handling
    • Infrastructure
      • Security Considerations for Cloud Provider or Deployment Model
      • Threat Modeling
  • API References
    • Authentication
      • MagicLink
        • Email a Magic Link
        • Resend Email Magic Link
        • Verify Magic Link
        • Ping Status
      • Magic Auth Code
        • Email a Magic Auth Code
        • Resend Magic Auth Code
        • Verify Magic Auth Code
      • Phone Authentication
        • Send Magic Auth Code via SMS
        • Resend Magic Auth Code via SMS
        • Phone Magic Auth Verify
      • PassKey
        • Initiate Passkey Login
        • Passkey Registration Initialize
        • Finish Passkey Authentication
        • Complete Passkey Registration
        • Check User Passkey Authentication Status
        • List User PassKey Credentials
        • Update Passkey Name
        • Delete Associated Passkey
      • GET Auth Status
    • Token
      • Refresh Token
      • Access Token By Auth Code
    • Mutli-Factor Authentication (MFA)
      • MFA Access Token
      • List of Authenticators
      • MFA Enroll TOTP
      • Initiate MFA
      • QR Code Image API
      • Validate MFA Token
      • Get Backup Code
    • Role And Permission
      • List All Roles
        GET
      • List All Permission
        GET
      • Create New Role
        POST
      • Update Existing Role
        PUT
      • Update Permission By Permission Id
        PUT
      • Remove Organization Role By Role Id
        DELETE
      • Remove Organization Permission By Permission Id
        DELETE
    • User Management
      • List All Users
      • GET User By User Id
      • GET User by User Email Address
      • Create a User
      • Update User by User Id
      • Verify User Status By User Id
      • Delete User By User Id
      • Manage User Roles
      • GET Users Organizations
      • GET User Login Logs
    • Organization
      • Add New Organization
      • Get Organization
      • Get All Organization
      • Update Organization
      • Delete Organization
      • GET Configuration By Client Id
      • GET Configuration By Custom Domain
  1. Role And Permission

Update Permission By Permission Id

PUT
https://api.ssojet.com/api/v1/permissions/{{permissionid}}

Update Permission By Permission Id#

This endpoint to update a specific permission by providing the permission ID in the URL path

#

Request
Method: PUT
URL: https://api.ssojet.com/api/v1/permissions/{{permissionid}}
Query Parameters:
client_id (string, required): The client ID for the permission.

Request Body#

Type: JSON
name (string): The name of the permission.
slug (string): The slug of the permission.
description (string): The description of the permission.

Response#

The response for this request will be a JSON object representing the updated permission, adhering to the following schema:
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
client_id
string 
required
This identifies the application making the request to the SSOJET server. You can find your client ID on the API Keys page in the dashboard
Example:
string
Header Params
accept
string 
required
Example:
*/*
accept-language
string 
required
Example:
en-US,en;q=0.9
content-type
string 
required
Example:
application/json
user-agent
string 
required
Example:
SSOJET API
Content-Type
string 
optional
Default:
application/json
User-Agent
string 
optional
Default:
SSOjet/1.0.0 (https://ssojet.com)
Body Params application/json
name
string 
required
slug
string 
required
description
string 
required
Example
{"name":"<Permission name>","slug":"<Permission unique identifier>","description":"<Permission description>"}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request PUT 'https://api.ssojet.com/api/v1/permissions/{{permissionid}}?client_id=string&client_id=' \
--header 'accept: */*' \
--header 'accept-language: en-US,en;q=0.9' \
--header 'user-agent: SSOJET API' \
--header 'User-Agent: SSOjet/1.0.0 (https://ssojet.com)' \
--header 'Content-Type: application/json' \
--data-raw '{"name":"<Permission name>","slug":"<Permission unique identifier>","description":"<Permission description>"}'

Responses

⚪0Update Permission By Permission Id
application/json
Body
array of:
id
string 
required
name
string 
required
slug
string 
required
description
string 
required
permission_id
array[string] | null 
required
is_deleted
boolean 
required
is_active
boolean 
required
Example
[
    {
        "id": "668e7e5946b448ab754b44ab",
        "name": "Owner",
        "slug": "owner",
        "description": "Owner Role",
        "permission_id": [
            "668e7e5946b448ab754b44a8",
            "668e7e5946b448ab754b44a9",
            "668e7e5946b448ab754b44aa"
        ],
        "is_deleted": false,
        "is_active": true
    },
    {
        "id": "668e7e5946b448ab754b44ac",
        "name": "Admin",
        "slug": "admin",
        "description": "Admin Role",
        "permission_id": [
            "668e7e5946b448ab754b44a8",
            "668e7e5946b448ab754b44a9",
            "668e7e5946b448ab754b44aa"
        ],
        "is_deleted": false,
        "is_active": true
    },
    {
        "id": "668e7e5a46b448ab754b44ad",
        "name": "Developer",
        "slug": "developer",
        "description": "Developer Role",
        "permission_id": [
            "668e7e5946b448ab754b44aa"
        ],
        "is_deleted": false,
        "is_active": true
    },
    {
        "id": "669237682b88a61a26a4770d",
        "name": "test",
        "slug": "test",
        "description": "test",
        "permission_id": null,
        "is_deleted": false,
        "is_active": true
    },
    {
        "id": "6694d402683339fb1c661c9c",
        "name": "testtole",
        "slug": "testtole",
        "description": "testtole",
        "permission_id": null,
        "is_deleted": false,
        "is_active": true
    }
]
Previous
Update Existing Role
Next
Remove Organization Role By Role Id
Built with