Skip to main content

Update Organization

PUT 
/updateOrganization

This API updates an organization in SSM.

The Authorization must have Bearer followed by Token.

Mandatory params:

organizationname,
username - user who is updating the organization

Optional params:

updatedorgname - param to update organization name

Organization Detail attributes can be passed like organizationtype, parentorganization, primarycontact, customproperty<1 to 20> etc.

Note: organization status update is not allowed.

endpoints - List of endpoints with params -

  1. endpointname
  2. updatetype - ADD/REMOVE

roles - List of roles with params -

  1. rolename
  2. updatetype - ADD/REMOVE

rules - List of rules with params -

  1. name
  2. type - BUISNESS/TECH/USERUPDATE/NEWUSER/REMOVEUSER/UPDATE_ENTITLEMENT/NEW_ENTITLEMENT/REMOVE_ENTITLEMENT/REQUEST
  3. updatetype - ADD/REMOVE

entitlements - List of entitlements with params -

  1. entitlementvalue
  2. entitlementtype
  3. endpoint
  4. updatetype - ADD/REMOVE

users - List of users with params -

  1. username
  2. updatetype - ADD/REMOVE

owners -

  1. owner
  2. rank
  3. updatetype(add/update/remove)
  4. policy(can be SUPERADMIN/ADMIN/BULKADMIN/READONLY)

attributes -

  1. attributegroupname
  2. attributes
  3. value
  4. attributevalues
  5. updatetype(addgroup/deletegroup/updategroup)

Request​

Path Parameters

    path stringrequired

Body

    attributes

    object[]

  • Array [

    • attributegroupname string
    attributes string

    attributevalues

    object

    pincode string
    street string
    updatetype string
    value string

  • ]

    • comments string
    customproperty10 string
    customproperty5 string

    endpoints

    object[]

  • Array [

    • cp1 string
    cp2 string
    cp3 string
    cp4 string
    cp5 string
    endpointname string
    updatetype string

  • ]

    • entitlements

    object[]

  • Array [

    • endpoint string
    entitlementtype string
    entitlementvalue string
    updatetype string

  • ]

    • location string
    organizationname string
    organizationtype string

    owners

    object[]

  • Array [

    • owner string
    rank number
    updatetype string

  • ]

    • parentorganization string
    primarycontact string

    roles

    object[]

  • Array [

    • rolename string
    updatetype string

  • ]

    • status string
    username string

    users

    object[]

  • Array [

    • updatetype string
    username string

  • ]

Responses​

Update Organization

Response Headers

  • Access-Control-Allow-Credentials

    string

  • Access-Control-Allow-Origin

    string

  • Cache-Control

    string

  • Date

    string

  • Expires

    string

  • Pragma

    string

  • Referrer-Policy

    string

  • Server

    string

  • Set-Cookie

    string

  • Strict-Transport-Security

    string

  • Transfer-Encoding

    string

  • X-Content-Type-Options

    string

  • X-Frame-Options

    string

  • X-XSS-Protection

    string

Schema

    errorCode string
    msg string
Loading...